Change Updates

Do not miss any Connect API changes, ever again

Subscribe to the Connect API changelog to be up to date on recent changes.

RSS

1 day ago

main
1.33.0
Compare
1.33.0

API structure has changed

Next change
71 structure changes including:
12 Breaking changes
13 Additions
46 Modifications
12 Removals
Modified 46 Breaking
GET /references/authorisationdomains
  • Response
  • 200 response Modified
    • application/json content type Modified
      • content property Modified
        • FederationID property Added
GET /references/authorisationdomains/{AuthorisationDomainName}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • FederationID property Added
GET /references/authorisationdomains/{AuthorisationDomainName}/authorisationdomainroles/{AuthorisationDomainRoleIdentifier}/metadata
  • Response
  • 200 response Modified
    • application/json content type Modified
      • content property Modified
        • Name, Status, Type properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • ClaimName, DataType, EntityType, PolicyOperator, Value, Values properties Added
GET /references/authorisationdomains/{AuthorisationDomainName}/authorisationdomainroles/{AuthorisationDomainRoleIdentifier}/metadata/{MetadataId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Name, Status, Type properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • ClaimName, DataType, EntityType, PolicyOperator, Value, Values properties Added
GET /references/authorities
  • Response
  • 200 response Modified
    • application/json content type Modified
      • content property Modified
        • AuthorityCode, AuthorityUri, Status properties Modified
          • Properties are now required
            Breaking
        • OrganisationId, OrganisationName properties Added
  • Query
  • organisationId, status, omitLegacy query parameters Added
GET /references/authorities/{AuthorityId}
  • Operation is now deprecated
  • Response
  • 200 response Modified
    • application/json content type Modified
      • AuthorityCode, AuthorityUri, Status properties Modified
        • Properties are now required
      • OrganisationId, OrganisationName properties Added
GET /references/federations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • content property Modified
        • RemoteTrustAnchor property Modified
          • Type went from string(uri) to array[string(uri)]
            Breaking
GET /references/federations/{FederationId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • RemoteTrustAnchor property Modified
        • Type went from string(uri) to array[string(uri)]
          Breaking
POST /organisations
  • Response
  • 201 response Modified
    • application/json content type Modified
      • Authority property Added
POST /organisations/{OrganisationId}/authorisationservers
  • Body
  • application/json content type Modified
    • FederationId, OpenIDDiscoveryDocument properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • Issuer property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • FederationId, FederationEndpoint properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /organisations/{OrganisationId}/authorityclaims
  • Body
  • application/json content type Modified
    • Status property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • UniqueTechnicalIdenifier property Removed
    • AuthorisationDomainID, AuthorisationDomainRoleIdentifier properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • AuthorisationDomain, Role properties Modified
        • Properties are now deprecated
      • AuthorityId property Modified
        • Property is now required
          Breaking
        • Type went from string to string(uuid)
      • Status property Modified
        • Property is now required
          Breaking
      • UniqueTechnicalIdenifier property Removed
      • AuthorisationDomainID property Added
POST /organisations/{OrganisationId}/authoritydomainclaims
  • Body
  • application/json content type Modified
    • AuthorisationDomainID property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • AuthorisationDomainName property Modified
        • Property is now deprecated
      • AuthorityId property Modified
        • Property is now required
          Breaking
        • Type went from string to string(uuid)
      • Status property Modified
        • Property is now required
          Breaking
      • AuthorisationDomainID property Added
POST /organisations/{OrganisationId}/softwarestatements
  • Body
  • application/json content type Modified
    • Roles property Modified
      • Status property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • OrganisationAuthorisationDomainRoleClaimID property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • FederationEndpoint property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}/authorityclaims
  • Body
  • application/json content type Modified
    • Status property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • OrganisationAuthorisationDomainRoleClaimID property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • AuthorisationDomain, Role properties Modified
        • Properties are now deprecated
      • Status property Modified
        • Property is now required
          Breaking
      • SoftwareStatementId property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • OrganisationAuthorisationDomainRoleClaimID, AuthorisationDomainName, AuthorisationDomainRoleName, AuthorityName properties Added
POST /references/authorisationdomainroles/{AuthorisationDomainRoleName}/metadata
  • Body
  • application/json content type Modified
    • Name, Type properties Removed
    • ClaimName, DataType, EntityType, PolicyOperator, Value, Values properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • Name, Status, Type properties Removed
      • ClaimName, DataType, EntityType, PolicyOperator, Value, Values properties Added
POST /references/authorisationdomains
  • Body
  • application/json content type Modified
    • FederationID property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • FederationID property Added
POST /references/authorisationdomains/{AuthorisationDomainName}/authorisationdomainroles/{AuthorisationDomainRoleIdentifier}/metadata
  • Body
  • application/json content type Modified
    • Name, Type properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • ClaimName, DataType, EntityType, PolicyOperator, Value, Values properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • Name, Status, Type properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • ClaimName, DataType, EntityType, PolicyOperator, Value, Values properties Added
POST /references/federations
  • Body
  • application/json content type Modified
    • RemoteTrustAnchor property Modified
      • Type went from string(uri) to array[string(uri)]
        Breaking
  • Response
  • 201 response Modified
    • application/json content type Modified
      • RemoteTrustAnchor property Modified
        • Type went from string(uri) to array[string(uri)]
          Breaking
PUT /organisations/{OrganisationId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Authority property Added
PUT /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}
  • Body
  • application/json content type Modified
    • FederationId, OpenIDDiscoveryDocument properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • Issuer property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • FederationId, FederationEndpoint properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
PUT /organisations/{OrganisationId}/authorityclaims/{OrganisationAuthorityClaimId}
  • Body
  • application/json content type Modified
    • UniqueTechnicalIdenifier property Removed
    • AuthorisationDomainID, AuthorisationDomainRoleIdentifier properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • AuthorisationDomain, Role properties Modified
        • Properties are now deprecated
      • AuthorityId property Modified
        • Property is now required
          Breaking
        • Type went from string to string(uuid)
      • Status property Modified
        • Property is now required
          Breaking
      • UniqueTechnicalIdenifier property Removed
      • AuthorisationDomainID property Added
PUT /organisations/{OrganisationId}/authoritydomainclaims/{OrganisationAuthorityDomainClaimId}
  • Body
  • application/json content type Modified
    • AuthorityName property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • AuthorisationDomainID property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • AuthorisationDomainName property Modified
        • Property is now deprecated
      • AuthorityId property Modified
        • Property is now required
          Breaking
        • Type went from string to string(uuid)
      • Status property Modified
        • Property is now required
          Breaking
      • AuthorisationDomainID property Added
PUT /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}
  • Body
  • application/json content type Modified
    • Roles property Modified
      • Status property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • OrganisationAuthorisationDomainRoleClaimID property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • FederationEndpoint property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
PUT /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}/authorityclaims/{SoftwareAuthorityClaimId}
  • Body
  • application/json content type Modified
    • AuthorisationDomain, OrganisationAuthorisationDomainRoleClaimID, Role properties Added
PUT /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}/unlock
  • Response
  • 200 response Modified
    • application/json content type Modified
      • FederationEndpoint property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
PUT /references/authorisationdomainroles/{AuthorisationDomainRoleName}/metadata/{MetadataId}
  • Body
  • application/json content type Modified
    • Status property Removed
    • ClaimName, DataType, EntityType, PolicyOperator, Value, Values properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Name, Status, Type properties Removed
      • ClaimName, DataType, EntityType, PolicyOperator, Value, Values properties Added
PUT /references/authorisationdomains/{AuthorisationDomainName}
  • Body
  • application/json content type Modified
    • FederationID property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • FederationID property Added
PUT /references/authorisationdomains/{AuthorisationDomainName}/authorisationdomainroles/{AuthorisationDomainRoleIdentifier}/metadata/{MetadataId}
  • Body
  • application/json content type Modified
    • Status property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • ClaimName, DataType, EntityType, PolicyOperator, Value, Values properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Name, Status, Type properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • ClaimName, DataType, EntityType, PolicyOperator, Value, Values properties Added
PUT /references/authorities/{AuthorityId}
  • Operation is now deprecated
  • Body
  • application/json content type Modified
    • Status property Modified
      • Property is now required
    • AuthorityCountry, AuthorityName properties Removed
  • Response
  • 200 response Modified
    • application/json content type Modified
      • AuthorityCode, AuthorityUri, Status properties Modified
        • Properties are now required
      • OrganisationId, OrganisationName properties Added
PUT /references/federations/{FederationId}
  • Body
  • application/json content type Modified
    • RemoteTrustAnchor property Modified
      • Type went from string(uri) to array[string(uri)]
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • RemoteTrustAnchor property Modified
        • Type went from string(uri) to array[string(uri)]
          Breaking
GET /audit
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • property Modified
GET /organisations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • content property Modified
        • Authority property Added
  • Query
  • authority query parameter Added
GET /organisations/{OrganisationId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • OrgDetails property Modified
        • Authority property Added
GET /organisations/{OrganisationId}/authorisationservers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • FederationId, FederationEndpoint properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • FederationId, FederationEndpoint properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /organisations/{OrganisationId}/authorityclaims
  • Response
  • 200 response Modified
    • application/json content type Modified
      • AuthorisationDomain, Role properties Modified
        • Properties are now deprecated
      • AuthorityId property Modified
        • Property is now required
          Breaking
        • Type went from string to string(uuid)
      • Status property Modified
        • Property is now required
          Breaking
      • UniqueTechnicalIdenifier property Removed
      • AuthorisationDomainID property Added
GET /organisations/{OrganisationId}/authorityclaims/{OrganisationAuthorityClaimId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • AuthorisationDomain, Role properties Modified
        • Properties are now deprecated
      • AuthorityId property Modified
        • Property is now required
          Breaking
        • Type went from string to string(uuid)
      • Status property Modified
        • Property is now required
          Breaking
      • UniqueTechnicalIdenifier property Removed
      • AuthorisationDomainID property Added
GET /organisations/{OrganisationId}/authoritydomainclaims
  • Response
  • 200 response Modified
    • application/json content type Modified
      • content property Modified
        • AuthorisationDomainName property Modified
          • Property is now deprecated
        • AuthorityId property Modified
          • Property is now required
            Breaking
          • Type went from string to string(uuid)
        • Status property Modified
          • Property is now required
            Breaking
        • AuthorisationDomainID property Added
GET /organisations/{OrganisationId}/authoritydomainclaims/{OrganisationAuthorityDomainClaimId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • AuthorisationDomainName property Modified
        • Property is now deprecated
      • AuthorityId property Modified
        • Property is now required
          Breaking
        • Type went from string to string(uuid)
      • Status property Modified
        • Property is now required
          Breaking
      • AuthorisationDomainID property Added
GET /organisations/{OrganisationId}/softwarestatements
  • Response
  • 200 response Modified
    • application/json content type Modified
      • FederationEndpoint property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • FederationEndpoint property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}/authorityclaims
  • Response
  • 200 response Modified
    • application/json content type Modified
      • AuthorisationDomain, Role properties Modified
        • Properties are now deprecated
      • Status property Modified
        • Property is now required
          Breaking
      • SoftwareStatementId property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • OrganisationAuthorisationDomainRoleClaimID, AuthorisationDomainName, AuthorisationDomainRoleName, AuthorityName properties Added
GET /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}/authorityclaims/{SoftwareAuthorityClaimId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • AuthorisationDomain, Role properties Modified
        • Properties are now deprecated
      • Status property Modified
        • Property is now required
          Breaking
      • SoftwareStatementId property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • OrganisationAuthorisationDomainRoleClaimID, AuthorisationDomainName, AuthorisationDomainRoleName, AuthorityName properties Added
GET /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}/metadata
  • Response
  • 200 response Modified
    • application/json content type Modified
      • content property Modified
        • Name, Status, Type properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • ClaimName, DataType, EntityType, PolicyOperator, Value, Values properties Added
GET /references/authorisationdomainroles/{AuthorisationDomainRoleName}/metadata
  • Response
  • 200 response Modified
    • application/json content type Modified
      • content property Modified
        • Name, Status, Type properties Removed
        • ClaimName, DataType, EntityType, PolicyOperator, Value, Values properties Added
GET /references/authorisationdomainroles/{AuthorisationDomainRoleName}/metadata/{MetadataId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Name, Status, Type properties Removed
      • ClaimName, DataType, EntityType, PolicyOperator, Value, Values properties Added
Removed 12 Breaking
PUT /references/authorities/{AuthorityId}/authorisationdomains/{AuthorityAuthorisationDomainId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/federation/{FederationConfigId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /references/authorities/{AuthorityId}/authorisationdomains
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /references/authorities
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/federation
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /references/authoritydomainmapping
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /references/authorities/{AuthorityId}/authorisationdomains/{AuthorityAuthorisationDomainId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /references/authorities/{AuthorityId}/authorisationdomains
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/federation/{FederationConfigId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/federation
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /references/authorities/{AuthorityId}/authorisationdomains/{AuthorityAuthorisationDomainId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/federation/{FederationConfigId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 13
PUT /references/authorityauthorisationdomains/{AuthorityAuthorisationDomainId}
PUT /organisations/{OrganisationId}/authority-configuration/{AuthorityId}
PUT /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/authorityclaims/{ServerAuthorityClaimID}
POST /references/authorityauthorisationdomains
POST /organisations/{OrganisationId}/authority-configuration
POST /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/authorityclaims
GET /references/authorityauthorisationdomains/{AuthorityAuthorisationDomainId}
GET /references/authorityauthorisationdomains
GET /organisations/{OrganisationId}/authority-configuration/{AuthorityId}
GET /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/authorityclaims/{ServerAuthorityClaimID}
GET /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/authorityclaims
DELETE /references/authorityauthorisationdomains/{AuthorityAuthorisationDomainId}
DELETE /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/authorityclaims/{ServerAuthorityClaimID}