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

Changelog

Last update:
Compare
1.33.0
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}
1.31.0
12 structure changes including:
11 Breaking changes
1 Modification
11 Removals
Modified 1
GET /organisations/{OrganisationId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • TncDetails property Modified
        • TnCsToBeSigned property Modified
Removed 11 Breaking
DELETE /references/apifamilies/{ApiFamilyID}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /references/apifamilies/{ApiFamilyID}/conformanceconfigurations/{ConformanceConfigurationID}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /references/apifamilies
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /references/apifamilies/{ApiFamilyID}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /references/apifamilies/{ApiFamilyID}/conformanceconfigurations
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /references/apifamilies/{ApiFamilyID}/conformanceconfigurations/{ConformanceConfigurationID}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /references/apifamilies
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /references/apifamilies/init
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /references/apifamilies/{ApiFamilyID}/conformanceconfigurations
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /references/apifamilies/{ApiFamilyID}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /references/apifamilies/{ApiFamilyID}/conformanceconfigurations/{ConformanceConfigurationID}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
3 structure changes including:
3 Modifications
Modified 3
GET /organisations/{OrganisationId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • TncDetails property Modified
        • TnCsToBeSigned property Modified
GET /references/apifamilies/{ApiFamilyID}/conformanceconfigurations
  • Path
  • ApiFamilyID path parameter Added
POST /references/apifamilies/{ApiFamilyID}/conformanceconfigurations
  • Path
  • ApiFamilyID path parameter Added
1.32.1
3 structure changes including:
3 Modifications
Modified 3
GET /organisations/{OrganisationId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • TncDetails property Modified
        • TnCsToBeSigned property Modified
GET /references/apifamilies
  • Response
  • 200, 400, 401, 403, 404, 406, 429, 500, 502, 504 responses Added
GET /references/apifamilies/{ApiFamilyID}/conformanceconfigurations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Type is now object
      • PaginationProperties property Added
1.32.0
12 structure changes including:
11 Additions
1 Modification
Modified 1
GET /organisations/{OrganisationId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • TncDetails property Modified
        • TnCsToBeSigned property Modified
Added 11
DELETE /references/apifamilies/{ApiFamilyID}
DELETE /references/apifamilies/{ApiFamilyID}/conformanceconfigurations/{ConformanceConfigurationID}
GET /references/apifamilies
GET /references/apifamilies/{ApiFamilyID}
GET /references/apifamilies/{ApiFamilyID}/conformanceconfigurations
GET /references/apifamilies/{ApiFamilyID}/conformanceconfigurations/{ConformanceConfigurationID}
POST /references/apifamilies
POST /references/apifamilies/init
POST /references/apifamilies/{ApiFamilyID}/conformanceconfigurations
PUT /references/apifamilies/{ApiFamilyID}
PUT /references/apifamilies/{ApiFamilyID}/conformanceconfigurations/{ConformanceConfigurationID}
2 structure changes including:
2 Modifications
Modified 2
GET /organisations
  • Query
  • member query parameter Added
GET /organisations/{OrganisationId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • TncDetails property Modified
        • TnCsToBeSigned property Modified
1.31.0
6 structure changes including:
5 Additions
1 Modification
Modified 1
GET /organisations/{OrganisationId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • TncDetails property Modified
        • TnCsToBeSigned property Modified
Added 5
DELETE /references/contacttypes/{ContactTypeID}
GET /references/contacttypes
GET /references/contacttypes/{ContactTypeID}
POST /references/contacttypes
PUT /references/contacttypes/{ContactTypeID}
1.29.4
4 structure changes including:
4 Modifications
Modified 4
GET /organisations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • content property Modified
        • TaxRegistrationNumber property Added
GET /organisations/{OrganisationId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • OrgDetails property Modified
        • TaxRegistrationNumber property Added
      • TncDetails property Modified
        • TnCsToBeSigned property Modified
POST /organisations
  • Body
  • application/json content type Modified
    • TaxRegistrationNumber property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • TaxRegistrationNumber property Added
PUT /organisations/{OrganisationId}
  • Body
  • application/json content type Modified
    • TaxRegistrationNumber property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • TaxRegistrationNumber property Added
8 structure changes including:
8 Modifications
Modified 8
GET /organisations/{OrganisationId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • TncDetails property Modified
        • TnCsToBeSigned property Modified
GET /organisations/{OrganisationId}/certificates
  • Response
  • 200 response Modified
    • application/jwk-set+json content type Modified
      • crv, x, y properties Added
GET /organisations/{OrganisationId}/certificates/kid/{CertificateOrKeyId}
  • Response
  • 200 response Modified
    • application/jwk+json content type Modified
      • crv, x, y properties Added
GET /organisations/{OrganisationId}/certificates/{OrganisationCertificateType}
  • Response
  • 200 response Modified
    • application/jwk-set+json content type Modified
      • crv, x, y properties Added
GET /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}/certificates
  • Response
  • 200 response Modified
    • application/jwk-set+json content type Modified
      • crv, x, y properties Added
GET /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}/certificates/{SoftwareStatementCertificateOrKeyType}/{CertificateOrKeyId}
  • Response
  • 200 response Modified
    • application/jwk+json content type Modified
      • crv, x, y properties Added
POST /organisations/{OrganisationId}/certificates/{OrganisationCertificateType}
  • Response
  • 201 response Modified
    • application/jwk+json content type Modified
      • crv, x, y properties Added
POST /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}/certificates/{SoftwareStatementCertificateOrKeyType}
  • Response
  • 201 response Modified
    • application/jwk+json content type Modified
      • crv, x, y properties Added
31 structure changes including:
31 Modifications
Modified 31
GET /audit
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pageable property Modified
        • mode property Added
GET /clients
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pageable property Modified
        • mode property Added
GET /organisations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pageable property Modified
        • mode property Added
GET /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/federation
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pageable property Modified
        • mode property Added
GET /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/sso-configuration
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pageable property Modified
        • mode property Added
GET /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/sso-configuration/{ssoConfigurationId}/versions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pageable property Modified
        • mode property Added
GET /organisations/{OrganisationId}/authoritydomainclaims
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pageable property Modified
        • mode property Added
GET /organisations/{OrganisationId}/contacts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pageable property Modified
        • mode property Added
GET /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}/metadata
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pageable property Modified
        • mode property Added
GET /organisations/{OrganisationId}/tnchistory
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pageable property Modified
        • mode property Added
GET /organisations/{OrganisationId}/{AuthorisationDomainName}/users
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pageable property Modified
        • mode property Added
GET /organisations/{OrganisationId}/{AuthorisationDomainName}/users/{UserEmailOrID}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pageable property Modified
        • mode property Added
GET /references/authorisationdomainroles
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pageable property Modified
        • mode property Added
GET /references/authorisationdomainroles/{AuthorisationDomainRoleName}/metadata
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pageable property Modified
        • mode property Added
GET /references/authorisationdomains
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pageable property Modified
        • mode property Added
GET /references/authorisationdomains/{AuthorisationDomainName}/authorisationdomainroles
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pageable property Modified
        • mode property Added
GET /references/authorisationdomains/{AuthorisationDomainName}/authorisationdomainroles/{AuthorisationDomainRoleIdentifier}/metadata
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pageable property Modified
        • mode property Added
GET /references/authorities
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pageable property Modified
        • mode property Added
GET /references/authorities/{AuthorityId}/authorisationdomains
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pageable property Modified
        • mode property Added
GET /references/authoritydomainmapping
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pageable property Modified
        • mode property Added
GET /references/certificationtypes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pageable property Modified
        • mode property Added
GET /references/certificationtypes/{TypeID}/variants
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pageable property Modified
        • mode property Added
GET /references/federations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pageable property Modified
        • mode property Added
GET /references/federations/{FederationId}/metadata-policy
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pageable property Modified
        • mode property Added
GET /references/flags
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pageable property Modified
        • mode property Added
GET /references/termsandconditions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pageable property Modified
        • mode property Added
GET /references/users/authorisationdomain/systems
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pageable property Modified
        • mode property Added
GET /references/users/authorisationdomain/usertypes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pageable property Modified
        • mode property Added
GET /users/data-administrator
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pageable property Modified
        • mode property Added
GET /users/super
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pageable property Modified
        • mode property Added
GET /users/{UserEmailOrID}/history
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pageable property Modified
        • mode property Added
1.29.3
2 structure changes including:
2 Modifications
Modified 2
GET /clients
  • Response
  • 200 response Modified
    • application/json content type Modified
      • content property Modified
        • organisation_company_register, organisation_country, organisation_registration_number, software_api_webhook_uri, software_flags properties Added
GET /clients/{ClientId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • organisation_company_register, organisation_country, organisation_registration_number, software_api_webhook_uri, software_flags properties Added
1.29.2
1 structure change including:
1 Modification
Modified 1
PUT /references/certificationtypes/{TypeID}/variants/{VariantID}
  • Body
  • application/json content type Modified
    • Cascade property Added
23 structure changes including:
10 Additions
13 Modifications
Modified 13 Breaking
PUT /references/authorisationdomains/{AuthorisationDomainName}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • AuthorisationDomainID property Added
PUT /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}
  • Body
  • application/json content type Modified
    • CustomerFriendlyLogoUri, Status properties Modified
      • Properties are now required
        Breaking
    • OmitFromEcosystem property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • AutoRegistrationSupported, CustomerFriendlyDescription, CustomerFriendlyLogoUri, CustomerFriendlyName properties Modified
        • Properties are now required
          Breaking
      • OrganisationId property Modified
        • Property is now deprecated
      • OmitFromEcosystem property Added
PUT /organisations/{OrganisationId}
  • Body
  • application/json content type Modified
    • EnforceIdpUserManagement property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • EnforceIdpUserManagement property Added
POST /references/authorisationdomains
  • Response
  • 201 response Modified
    • application/json content type Modified
      • AuthorisationDomainID property Added
POST /organisations/{OrganisationId}/authorisationservers
  • Body
  • application/json content type Modified
    • CustomerFriendlyLogoUri property Modified
      • Property is now required
        Breaking
    • Status property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • OmitFromEcosystem property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • AutoRegistrationSupported, CustomerFriendlyDescription, CustomerFriendlyLogoUri, CustomerFriendlyName properties Modified
        • Properties are now required
          Breaking
      • OrganisationId property Modified
        • Property is now deprecated
      • OmitFromEcosystem property Added
POST /organisations
  • Body
  • application/json content type Modified
    • EnforceIdpUserManagement property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • EnforceIdpUserManagement property Added
GET /references/authorisationdomains/{AuthorisationDomainName}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • AuthorisationDomainID property Added
GET /references/authorisationdomains
  • Response
  • 200 response Modified
    • application/json content type Modified
      • content property Modified
        • AuthorisationDomainID property Added
GET /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • AutoRegistrationSupported, CustomerFriendlyDescription, CustomerFriendlyLogoUri, CustomerFriendlyName properties Modified
        • Properties are now required
          Breaking
      • OrganisationId property Modified
        • Property is now deprecated
      • OmitFromEcosystem property Added
GET /organisations/{OrganisationId}/authorisationservers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • AutoRegistrationSupported, CustomerFriendlyDescription, CustomerFriendlyLogoUri, CustomerFriendlyName properties Modified
        • Properties are now required
          Breaking
      • OrganisationId property Modified
        • Property is now deprecated
      • OmitFromEcosystem property Added
  • Query
  • omitFromEcosystem query parameter Added
GET /organisations/{OrganisationId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • OrgDetails property Modified
        • EnforceIdpUserManagement property Added
GET /organisations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • content property Modified
        • EnforceIdpUserManagement property Added
GET /audit
  • Query
  • resourceType query parameter Modified
    • Query parameter is now required
      Breaking
  • parentResourceId query parameter Added
Added 10
PUT /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/sso-configuration/{ssoConfigurationId}/versions/{versionId}
PUT /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/sso-configuration/{ssoConfigurationId}
POST /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/sso-configuration/{ssoConfigurationId}/versions
POST /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/sso-configuration
GET /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/sso-configuration/{ssoConfigurationId}/versions/{versionId}
GET /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/sso-configuration/{ssoConfigurationId}/versions
GET /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/sso-configuration/{ssoConfigurationId}
GET /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/sso-configuration
DELETE /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/sso-configuration/{ssoConfigurationId}/versions/{versionId}
DELETE /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/sso-configuration/{ssoConfigurationId}
1 structure change including:
1 Modification
Modified 1
GET /search
  • Response
  • 200 response Modified
    • application/json content type Modified
      • results property Modified
        • softwareStatementId property Added
1.28.0
1 structure change including:
1 Addition
Added 1
GET /search
11 structure changes including:
11 Modifications
Modified 11
DELETE /references/authorisationdomainroles/{AuthorisationDomainRoleName}
  • Operation is now deprecated
DELETE /references/authorisationdomainroles/{AuthorisationDomainRoleName}/metadata/{MetadataId}
  • Operation is now deprecated
DELETE /references/authorisationdomains/{AuthorisationDomainName}/authorisationdomainroles/{AuthorisationDomainRoleIdentifier}/metadata/{MetadataId}
  • Operation is now deprecated
GET /references/authorisationdomainroles
  • Operation is now deprecated
GET /references/authorisationdomainroles/{AuthorisationDomainRoleName}
  • Operation is now deprecated
GET /references/authorisationdomainroles/{AuthorisationDomainRoleName}/metadata
  • Operation is now deprecated
GET /references/authorisationdomainroles/{AuthorisationDomainRoleName}/metadata/{MetadataId}
  • Operation is now deprecated
POST /references/authorisationdomainroles
  • Operation is now deprecated
POST /references/authorisationdomainroles/{AuthorisationDomainRoleName}/metadata
  • Operation is now deprecated
PUT /references/authorisationdomainroles/{AuthorisationDomainRoleName}
  • Operation is now deprecated
PUT /references/authorisationdomainroles/{AuthorisationDomainRoleName}/metadata/{MetadataId}
  • Operation is now deprecated