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.8.1
8 structure changes including:
8 Modifications
Modified 8
GET /organisations/{OrganisationId}/authorityclaims
  • Response
  • 200 response Modified
    • Exclusive property Added
GET /organisations/{OrganisationId}/authorityclaims/{OrganisationAuthorityClaimId}
  • Response
  • 200 response Modified
    • Exclusive property Added
GET /references/authorisationdomainroles
  • Response
  • 200 response Modified
    • content property Modified
GET /references/authorisationdomainroles/{AuthorisationDomainRoleName}
  • Response
  • 200 response Modified
    • Exclusive property Added
POST /organisations/{OrganisationId}/authorityclaims
  • Response
  • 201 response Modified
    • Exclusive property Added
POST /references/authorisationdomainroles
  • Body
  • content type Modified
    • Exclusive property Added
  • Response
  • 201 response Modified
    • Exclusive property Added
PUT /organisations/{OrganisationId}/authorityclaims/{OrganisationAuthorityClaimId}
  • Response
  • 200 response Modified
    • Exclusive property Added
PUT /references/authorisationdomainroles/{AuthorisationDomainRoleName}
  • Body
  • content type Modified
    • Exclusive property Added
  • Response
  • 200 response Modified
    • Exclusive property Added
1.7.0
29 structure changes including:
2 Additions
27 Modifications
Modified 27 Breaking
PUT /references/termsandconditions/{TnCId}
  • Body
  • content type Modified
    • Status property Added
PUT /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}/unlock
  • Response
  • 200 response Modified
    • ApiWebhookUri, ClientSecret, CreatedAt properties Added
PUT /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}
  • Body
  • content type Modified
    • ApiWebhookUri property Added
  • Response
  • 200 response Modified
    • ApiWebhookUri, ClientSecret, CreatedAt properties Added
PUT /organisations/{OrganisationId}/authorityclaims/{OrganisationAuthorityClaimId}
  • Response
  • 200 response Modified
    • Metadata, RoleType properties Added
PUT /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}
  • Response
  • 200 response Modified
    • CreatedAt property Added
POST /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}/certificates/{SoftwareStatementCertificateOrKeyType}
  • Response
  • 201 response Modified
    • RevokedDateTime property Added
POST /organisations/{OrganisationId}/softwarestatements
  • Body
  • content type Modified
    • ApiWebhookUri property Added
  • Response
  • 201 response Modified
    • ApiWebhookUri, ClientSecret, CreatedAt properties Added
POST /organisations/{OrganisationId}/certificates/{OrganisationCertificateType}
  • Response
  • 201 response Modified
    • RevokedDateTime property Added
POST /organisations/{OrganisationId}/authorityclaims
  • Response
  • 201 response Modified
    • Metadata, RoleType properties Added
POST /organisations/{OrganisationId}/authorisationservers
  • Response
  • 201 response Modified
    • CreatedAt property Added
POST /clients
  • Response
  • 201 response Modified
    • software_statement_id, terms_of_service_uri properties Removed
    • org_id, roles, software_id, tos_uri properties Added
GET /references/authorities
  • Response
  • 200 response Modified
    • AuthorityCode, AuthorityCountry, AuthorityId, AuthorityName, AuthorityUri, Status properties Removed
    • content, empty, numberOfElements, offset, pageNumber, pageable, size, totalPages, totalSize properties Added
  • Query
  • authorityName, authorityCountry query parameters Added
GET /references/authorisationdomains
  • Query
  • domainName, domainRegion query parameters Added
GET /references/authorisationdomainroles
  • Query
  • domainRole, status, domain, type query parameters Added
GET /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}/certificates/{SoftwareStatementCertificateOrKeyType}/{CertificateOrKeyId}
  • Response
  • 200 response Modified
    • RevokedDateTime property Added
GET /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}/certificates
  • Response
  • 200 response Modified
    • RevokedDateTime property Added
GET /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}
  • Response
  • 200 response Modified
    • ApiWebhookUri, ClientSecret, CreatedAt properties Added
GET /organisations/{OrganisationId}/softwarestatements
  • Response
  • 200 response Modified
    • ApiWebhookUri, ClientSecret, CreatedAt properties Added
GET /organisations/{OrganisationId}/certificates/{OrganisationCertificateType}
  • Response
  • 200 response Modified
    • RevokedDateTime property Added
GET /organisations/{OrganisationId}/certificates/kid/{CertificateOrKeyId}
  • Response
  • 200 response Modified
    • RevokedDateTime property Added
GET /organisations/{OrganisationId}/certificates
  • Response
  • 200 response Modified
    • RevokedDateTime property Added
GET /organisations/{OrganisationId}/authorityclaims/{OrganisationAuthorityClaimId}
  • Response
  • 200 response Modified
    • Metadata, RoleType properties Added
GET /organisations/{OrganisationId}/authorityclaims
  • Response
  • 200 response Modified
    • Metadata, RoleType properties Added
GET /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}
  • Response
  • 200 response Modified
    • CreatedAt property Added
GET /organisations/{OrganisationId}/authorisationservers
  • Response
  • 200 response Modified
    • CreatedAt property Added
GET /clients/{ClientId}
  • Response
  • 200 response Modified
    • software_statement_id, terms_of_service_uri properties Removed
    • org_id, roles, software_id, tos_uri properties Added
GET /clients
  • Response
  • 200 response Modified
    • content property Modified
Added 2
POST /organisations/{OrganisationId}/ess/reissue/{ExternalSigningServiceEnvelopeId}
GET /users/super
1.6.0
2 structure changes including:
1 Addition
1 Modification
Modified 1
POST /references/authorities/{AuthorityId}/authorisationdomains
  • Body
  • content type Modified
    • Status property Added
Added 1
PUT /references/authorities/{AuthorityId}/authorisationdomains/{AuthorityAuthorisationDomainId}
1.5.0
2 structure changes including:
2 Modifications
Modified 2 Breaking
POST /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/apiresources/{ApiResourceId}/apidiscoveryendpoints
  • Body
  • content type Modified
    • ApiEndpoint property Removed
    • ApiEndpoints property Added
  • Response
  • 201 response Modified
    • ApiDiscoveryEndpoint property Removed
    • ApiDiscoveryEndpoints property Added
PUT /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/apiresources/{ApiResourceId}/apidiscoveryendpoints/{ApiDiscoveryEndpointId}
  • Body
  • content type Modified
    • ApiEndpoint property Removed
    • ApiEndpoints property Added
  • Response
  • 200 response Modified
    • ApiDiscoveryEndpoint property Removed
    • ApiDiscoveryEndpoints property Added
1.4.0
79 structure changes including:
39 Breaking changes
38 Additions
2 Modifications
39 Removals
Modified 2
PUT /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}
  • Body
  • content type Modified
    • ClientUri property Modified
    • Roles property Added
POST /organisations/{OrganisationId}/softwarestatements
  • Body
  • content type Modified
    • ClientUri property Modified
    • Roles property Added
Removed 39 Breaking
PUT /references/termsandconditions/{TnCId}
GET /references/authorisationdomains/{AuthorisationDomainName}
GET /references/authorisationdomains
GET /references/authorisationdomainroles/{AuthorisationDomainRoleName}/metadata/{MetadataId}
GET /references/authorisationdomainroles/{AuthorisationDomainRoleName}/metadata
GET /references/authorisationdomainroles/{AuthorisationDomainRoleName}
GET /references/authorisationdomainroles
GET /organisations/{OrganisationId}/{AuthorisationDomainName}/users/{UserEmailId}
GET /organisations/{OrganisationId}/{AuthorisationDomainName}/users
GET /organisations/{OrganisationId}/adminusers/{UserEmailId}
GET /organisations/{OrganisationId}/adminusers
GET /clients/{ClientId}
GET /clients
DELETE /references/termsandconditions/{TnCId}
DELETE /references/authorities/{AuthorityId}/authorisationdomains/{AuthorityAuthorisationDomainId}
DELETE /references/authorities/{AuthorityId}
DELETE /references/authorisationdomains/{AuthorisationDomainName}
DELETE /references/authorisationdomainroles/{AuthorisationDomainRoleName}/metadata/{MetadataId}
DELETE /references/authorisationdomainroles/{AuthorisationDomainRoleName}
PUT /references/authorities/{AuthorityId}
PUT /references/authorisationdomainroles/{AuthorisationDomainRoleName}
PUT /organisations/{OrganisationId}/adminusers/{UserEmailId}
POST /references/termsandconditions
POST /references/authorities/{AuthorityId}/authorisationdomains
POST /references/authorities
POST /references/authorisationdomains
POST /references/authorisationdomainroles/{AuthorisationDomainRoleName}/metadata
POST /references/authorisationdomainroles
POST /organisations/{OrganisationId}/{AuthorisationDomainName}/users
POST /organisations/{OrganisationId}/enrol
POST /organisations/{OrganisationId}/adminusers
POST /clients
GET /references/termsandconditions/{TnCId}
GET /references/termsandconditions
GET /references/authoritydomainmapping
GET /references/authorities/{AuthorityId}/authorisationdomains/{AuthorityAuthorisationDomainId}
GET /references/authorities/{AuthorityId}/authorisationdomains
GET /references/authorities/{AuthorityId}
GET /references/authorities
Added 38
GET /references/authorities
GET /references/authorisationdomains/{AuthorisationDomainName}
GET /references/authorisationdomains
GET /references/authorisationdomainroles/{AuthorisationDomainRoleName}/metadata/{MetadataId}
GET /references/authorisationdomainroles/{AuthorisationDomainRoleName}/metadata
GET /references/authorisationdomainroles/{AuthorisationDomainRoleName}
GET /references/authorisationdomainroles
GET /organisations/{OrganisationId}/{AuthorisationDomainName}/users/{UserEmailId}
GET /organisations/{OrganisationId}/{AuthorisationDomainName}/users
GET /organisations/{OrganisationId}/adminusers/{UserEmailId}
GET /organisations/{OrganisationId}/adminusers
GET /clients/{ClientId}
GET /clients
DELETE /references/termsandconditions/{TnCId}
DELETE /references/authorities/{AuthorityId}/authorisationdomains/{AuthorityAuthorisationDomainId}
DELETE /references/authorities/{AuthorityId}
DELETE /references/authorisationdomains/{AuthorisationDomainName}
DELETE /references/authorisationdomainroles/{AuthorisationDomainRoleName}/metadata/{MetadataId}
DELETE /references/authorisationdomainroles/{AuthorisationDomainRoleName}
PUT /references/termsandconditions/{TnCId}
PUT /references/authorities/{AuthorityId}
PUT /references/authorisationdomainroles/{AuthorisationDomainRoleName}
PUT /organisations/{OrganisationId}/adminusers/{UserEmailId}
POST /references/termsandconditions
POST /references/authorities/{AuthorityId}/authorisationdomains
POST /references/authorities
POST /references/authorisationdomains
POST /references/authorisationdomainroles/{AuthorisationDomainRoleName}/metadata
POST /references/authorisationdomainroles
POST /organisations/{OrganisationId}/{AuthorisationDomainName}/users
POST /organisations/{OrganisationId}/adminusers
POST /clients
GET /references/termsandconditions/{TnCId}
GET /references/termsandconditions
GET /references/authoritydomainmapping
GET /references/authorities/{AuthorityId}/authorisationdomains/{AuthorityAuthorisationDomainId}
GET /references/authorities/{AuthorityId}/authorisationdomains
GET /references/authorities/{AuthorityId}
1.3.14
20 structure changes including:
20 Modifications
Modified 20 Breaking
GET /clients
  • Response
  • 200 response Modified
    • application_type, claims, client_description, client_id, client_name, client_uri, grant_types, jwks_uri, last_updated, logo_uri, organisation_id, policy_uri, post_logout_redirect_uris, redirect_uris, response_types, scope, sector_identifier_uri, software_statement_id, software_version, status, subject_type, terms_of_service_uri, token_endpoint_auth_method properties Removed
    • content, empty, numberOfElements, offset, pageNumber, pageable, size, totalPages, totalSize properties Added
GET /clients/{ClientId}
  • Response
  • 200 response Modified
    • openid_federation_enabled, openid_federation_entity_management_type properties Added
GET /organisations
  • Response
  • 200 response Modified
    • pageable property Modified
GET /organisations/{OrganisationId}/authoritydomainclaims
  • Response
  • 200 response Modified
    • pageable property Modified
GET /organisations/{OrganisationId}/contacts
  • Response
  • 200 response Modified
    • pageable property Modified
GET /organisations/{OrganisationId}/softwarestatements
  • Response
  • 200 response Modified
    • IdTokenSignedResponseAlgorithm, OpenidFederationEnabled, OpenidFederationEntityManagementType, RequireSignedRequestObject, TokenEndpointAuthMethod properties Added
GET /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}
  • Response
  • 200 response Modified
    • IdTokenSignedResponseAlgorithm, OpenidFederationEnabled, OpenidFederationEntityManagementType, RequireSignedRequestObject, TokenEndpointAuthMethod properties Added
GET /organisations/{OrganisationId}/tnchistory
  • Response
  • 200 response Modified
    • pageable property Modified
GET /organisations/{OrganisationId}/{AuthorisationDomainName}/users
  • Response
  • 200 response Modified
    • pageable property Modified
GET /organisations/{OrganisationId}/{AuthorisationDomainName}/users/{UserEmailId}
  • Response
  • 200 response Modified
    • pageable property Modified
GET /references/authorisationdomainroles
  • Response
  • 200 response Modified
    • pageable property Modified
GET /references/authorisationdomains
  • Response
  • 200 response Modified
    • pageable property Modified
GET /references/authorities/{AuthorityId}/authorisationdomains
  • Response
  • 200 response Modified
    • pageable property Modified
GET /references/authoritydomainmapping
  • Response
  • 200 response Modified
    • pageable property Modified
GET /references/termsandconditions
  • Response
  • 200 response Modified
    • pageable property Modified
GET /users/{UserEmailId}/history
  • Response
  • 200 response Modified
    • pageable property Modified
POST /clients
  • Response
  • 201 response Modified
    • openid_federation_enabled, openid_federation_entity_management_type properties Added
POST /organisations/{OrganisationId}/softwarestatements
  • Body
  • content type Modified
    • IdTokenSignedResponseAlgorithm, OpenidFederationEnabled, OpenidFederationEntityManagementType, RequireSignedRequestObject, TokenEndpointAuthMethod properties Added
  • Response
  • 201 response Modified
    • IdTokenSignedResponseAlgorithm, OpenidFederationEnabled, OpenidFederationEntityManagementType, RequireSignedRequestObject, TokenEndpointAuthMethod properties Added
PUT /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}
  • Body
  • content type Modified
    • IdTokenSignedResponseAlgorithm, OpenidFederationEnabled, OpenidFederationEntityManagementType, RequireSignedRequestObject, TokenEndpointAuthMethod properties Added
  • Response
  • 200 response Modified
    • IdTokenSignedResponseAlgorithm, OpenidFederationEnabled, OpenidFederationEntityManagementType, RequireSignedRequestObject, TokenEndpointAuthMethod properties Added
PUT /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}/unlock
  • Response
  • 200 response Modified
    • IdTokenSignedResponseAlgorithm, OpenidFederationEnabled, OpenidFederationEntityManagementType, RequireSignedRequestObject, TokenEndpointAuthMethod properties Added
1.3.11
4 structure changes including:
4 Modifications
Modified 4
GET /organisations/{OrganisationId}/authorisationservers
  • Response
  • 200 response Modified
    • SupportsRedirect property Added
GET /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}
  • Response
  • 200 response Modified
    • SupportsRedirect property Added
POST /organisations/{OrganisationId}/authorisationservers
  • Response
  • 201 response Modified
    • SupportsRedirect property Added
PUT /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}
  • Response
  • 200 response Modified
    • SupportsRedirect property Added
1.3.10
3 structure changes including:
3 Modifications
Modified 3
GET /references/authorisationdomainroles/{AuthorisationDomainRoleName}
  • Response
  • 200 response Modified
    • RoleType property Added
POST /references/authorisationdomainroles
  • Body
  • content type Modified
    • RoleType property Added
  • Response
  • 201 response Modified
    • RoleType property Added
PUT /references/authorisationdomainroles/{AuthorisationDomainRoleName}
  • Body
  • content type Modified
    • RoleType property Added
  • Response
  • 200 response Modified
    • RoleType property Added
1.3.9
8 structure changes including:
3 Additions
5 Modifications
Modified 5
GET /organisations/{OrganisationId}/softwarestatements
  • Response
  • 200 response Modified
    • PostLogoutRedirectUris property Added
GET /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}
  • Response
  • 200 response Modified
    • PostLogoutRedirectUris property Added
POST /organisations/{OrganisationId}/softwarestatements
  • Body
  • content type Modified
    • PostLogoutRedirectUris property Added
  • Response
  • 201 response Modified
    • PostLogoutRedirectUris property Added
PUT /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}
  • Body
  • content type Modified
    • PostLogoutRedirectUris property Added
  • Response
  • 200 response Modified
    • PostLogoutRedirectUris property Added
PUT /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}/unlock
  • Response
  • 200 response Modified
    • PostLogoutRedirectUris property Added
Added 3
GET /clients
GET /clients/{ClientId}
POST /clients
1.3.7
9 structure changes including:
9 Modifications
Modified 9
GET /organisations/{OrganisationId}/softwarestatements
  • Response
  • 200 response Modified
    • SoftwareStatementCertifications property Modified
GET /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}
  • Response
  • 200 response Modified
    • SoftwareStatementCertifications property Modified
GET /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}/certifications
  • Response
  • 200 response Modified
    • ProfileType property Added
GET /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}/certifications/{SoftwareStatementCertificationId}
  • Response
  • 200 response Modified
    • ProfileType property Added
POST /organisations/{OrganisationId}/softwarestatements
  • Response
  • 201 response Modified
    • SoftwareStatementCertifications property Modified
POST /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}/certifications
  • Body
  • content type Modified
    • ProfileType property Added
  • Response
  • 201 response Modified
    • ProfileType property Added
PUT /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}
  • Response
  • 200 response Modified
    • SoftwareStatementCertifications property Modified
PUT /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}/certifications/{SoftwareStatementCertificationId}
  • Body
  • content type Modified
    • ProfileType property Added
  • Response
  • 200 response Modified
    • ProfileType property Added
PUT /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}/unlock
  • Response
  • 200 response Modified
    • SoftwareStatementCertifications property Modified
2 structure changes including:
2 Modifications
Modified 2
POST /organisations/{OrganisationId}/authorisationservers
  • Body
  • content type Modified
    • OpenIDDiscoveryDocument property Modified
PUT /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}
  • Body
  • content type Modified
    • OpenIDDiscoveryDocument property Modified
1.3.6
1 structure change including:
1 Modification
Modified 1
GET /organisations
  • Query
  • hideInactive query parameter Added