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.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
1.27.4
4 structure changes including:
4 Modifications
Modified 4 Breaking
GET /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}/metadata
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Type went from array[object] to object
        Breaking
      • content, empty, numberOfElements, offset, pageNumber, pageable, size, totalPages, totalSize properties Added
GET /references/authorisationdomainroles/{AuthorisationDomainRoleName}/metadata
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Type went from array[object] to object
        Breaking
      • content, empty, numberOfElements, offset, pageNumber, pageable, size, totalPages, totalSize properties Added
GET /references/authorisationdomains/{AuthorisationDomainName}/authorisationdomainroles/{AuthorisationDomainRoleIdentifier}/metadata
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Type went from array[object] to object
        Breaking
      • content, empty, numberOfElements, offset, pageNumber, pageable, size, totalPages, totalSize properties Added
PUT /references/authorisationdomains/{AuthorisationDomainName}/authorisationdomainroles/{AuthorisationDomainRoleIdentifier}/metadata/{MetadataId}
  • Response
  • 200 response Modified
    • application/json content type Added
1 structure change including:
1 Modification
Modified 1
GET /organisations/{OrganisationId}/authorisationservers
  • Query
  • filterBy query parameter Added
1 structure change including:
1 Modification
Modified 1
GET /organisations/{OrganisationId}/authorisationservers
  • Query
  • containsOpenIdDiscoveryDocument, status query parameters Added
1.27.3
2 structure changes including:
2 Modifications
Modified 2
POST /organisations/{OrganisationId}/softwarestatements
  • Body
  • application/json content type Modified
    • ClientId property Added
PUT /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}
  • Body
  • application/json content type Modified
    • ClientId property Added
1.27.2
1 structure change including:
1 Modification
Modified 1
GET /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}/certificates
  • Query
  • showOrgLevelCertificates query parameter Added
1.27.1
13 structure changes including:
10 Additions
3 Modifications
Modified 3 Breaking
PUT /references/authorisationdomainroles/{AuthorisationDomainRoleName}
  • Body
  • application/json content type Modified
    • AuthorisationDomainName property Modified
      • Property is no longer required
PUT /references/authorisationdomainroles/{AuthorisationDomainRoleName}/metadata/{MetadataId}
  • Response
  • 200 response Modified
    • application/json content type Added
PUT /references/authorisationdomains/{AuthorisationDomainName}
  • Body
  • application/json content type Modified
    • Status property Modified
      • Property is now required
        Breaking
Added 10
DELETE /references/authorisationdomains/{AuthorisationDomainName}/authorisationdomainroles/{AuthorisationDomainRoleIdentifier}
DELETE /references/authorisationdomains/{AuthorisationDomainName}/authorisationdomainroles/{AuthorisationDomainRoleIdentifier}/metadata/{MetadataId}
GET /references/authorisationdomains/{AuthorisationDomainName}/authorisationdomainroles
GET /references/authorisationdomains/{AuthorisationDomainName}/authorisationdomainroles/{AuthorisationDomainRoleIdentifier}
GET /references/authorisationdomains/{AuthorisationDomainName}/authorisationdomainroles/{AuthorisationDomainRoleIdentifier}/metadata
GET /references/authorisationdomains/{AuthorisationDomainName}/authorisationdomainroles/{AuthorisationDomainRoleIdentifier}/metadata/{MetadataId}
POST /references/authorisationdomains/{AuthorisationDomainName}/authorisationdomainroles
POST /references/authorisationdomains/{AuthorisationDomainName}/authorisationdomainroles/{AuthorisationDomainRoleIdentifier}/metadata
PUT /references/authorisationdomains/{AuthorisationDomainName}/authorisationdomainroles/{AuthorisationDomainRoleIdentifier}
PUT /references/authorisationdomains/{AuthorisationDomainName}/authorisationdomainroles/{AuthorisationDomainRoleIdentifier}/metadata/{MetadataId}
1.26.0
13 structure changes including:
13 Modifications
Modified 13
GET /organisations/{OrganisationId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • TncDetails property Modified
        • TnCsToBeSigned property Modified
GET /organisations/{OrganisationId}/authorityclaims
  • Response
  • 200 response Modified
    • application/json content type Modified
      • AuthorisationDomainRoleIdentifier property Added
GET /organisations/{OrganisationId}/authorityclaims/{OrganisationAuthorityClaimId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • AuthorisationDomainRoleIdentifier property Added
GET /references/authorisationdomainroles/{AuthorisationDomainRoleName}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • AuthorisationDomainRoleIdentifier property Added
GET /references/termsandconditions/{TnCId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • RoleIds property Added
GET /users/{UserEmailOrID}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • DirectoryTermsAndConditionsDetails property Modified
        • TermsAndConditionsItem property Modified
POST /organisations/{OrganisationId}/authorityclaims
  • Response
  • 201 response Modified
    • application/json content type Modified
      • AuthorisationDomainRoleIdentifier property Added
POST /organisations/{OrganisationId}/ess/initiatesigning
  • Response
  • 200 response Modified
    • application/json content type Modified
      • TermsAndConditionsDetail property Modified
        • TermsAndConditionsItem property Modified
POST /references/authorisationdomainroles
  • Response
  • 201 response Modified
    • application/json content type Modified
      • AuthorisationDomainRoleIdentifier property Added
POST /references/termsandconditions
  • Body
  • application/json content type Modified
    • RoleIds property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • RoleIds property Added
PUT /organisations/{OrganisationId}/authorityclaims/{OrganisationAuthorityClaimId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • AuthorisationDomainRoleIdentifier property Added
PUT /references/authorisationdomainroles/{AuthorisationDomainRoleName}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • AuthorisationDomainRoleIdentifier property Added
PUT /references/termsandconditions/{TnCId}
  • Body
  • application/json content type Modified
    • RoleIds property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • RoleIds property Added
1.25.0
1 structure change including:
1 Modification
Modified 1
GET /organisations/{OrganisationId}/softwarestatements
  • Query
  • status, filterBy query parameters Added