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.20.1
1 structure change including:
1 Modification
Modified 1 Breaking
GET /clients/{ClientId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • authorization_detail_types property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • authorization_details_types property Added
1 structure change including:
1 Modification
Modified 1
GET /clients/{ClientId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • authorization_detail_types property Added
1.20.0
1 structure change including:
1 Modification
Modified 1
GET /clients/{ClientId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • use_mtls_endpoint_aliases property Added
1.17.0
17 structure changes including:
5 Additions
12 Modifications
Modified 12 Breaking
PUT /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}/unlock
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Flags property Added
PUT /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}
  • Body
  • application/json content type Modified
    • PolicyUri property Modified
      • Full types went from string | null to string(uri)
        Breaking
      • PolicyUri property Modified
        • Full types went from string | null to string(uri)
          Breaking
    • Flags property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Flags property Added
PUT /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}
  • Body
  • application/json content type Modified
    • Flags property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • DeveloperPortalUri, TermsOfServiceUri properties Modified
        • Full types went from string(uri) to string(uri) | null
PUT /organisations/{OrganisationId}
  • Body
  • application/json content type Modified
    • Tags property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • Flags property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Tags property Modified
        • Property is now deprecated
      • Flags property Added
POST /organisations/{OrganisationId}/softwarestatements
  • Body
  • application/json content type Modified
    • PolicyUri property Modified
      • Full types went from string | null to string(uri)
        Breaking
      • PolicyUri property Modified
        • Full types went from string | null to string(uri)
          Breaking
    • Flags property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • Flags property Added
POST /organisations/{OrganisationId}/authorisationservers
  • Body
  • application/json content type Modified
    • Flags property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • DeveloperPortalUri, TermsOfServiceUri properties Modified
        • Full types went from string(uri) to string(uri) | null
POST /organisations
  • Body
  • application/json content type Modified
    • Tags property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • Flags property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • Tags property Modified
        • Property is now deprecated
      • Flags property Added
GET /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Flags property Added
GET /organisations/{OrganisationId}/softwarestatements
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • DeveloperPortalUri, TermsOfServiceUri properties Modified
        • Full types went from string(uri) to string(uri) | null
GET /organisations/{OrganisationId}/authorisationservers
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /organisations/{OrganisationId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • OrgDetails property Modified
Added 5
PUT /references/flags/{FlagID}
POST /references/flags
GET /references/flags/{FlagID}
GET /references/flags
DELETE /references/flags/{FlagID}
1.16.3
1 structure change including:
1 Modification
Modified 1
POST /organisations/{OrganisationId}/{AuthorisationDomainName}/users
  • Body
  • application/json content type Modified
    • SystemID property Modified
      • Property is no longer required
      • SystemID property Modified
        • Property is no longer required
    • UserTypeID property Modified
      • Property is no longer required
      • UserTypeID property Modified
        • Property is no longer required
    • ContactRole, System properties Added
15 structure changes including:
10 Additions
5 Modifications
Modified 5 Breaking
GET /users/{UserEmailId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • OrgAccessDetails property Modified
POST /organisations/{OrganisationId}/{AuthorisationDomainName}/users
  • Body
  • application/json content type Modified
    • ContactRole, System properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • SystemID, UserTypeID properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • SystemID, UserTypeID properties Added
POST /users
  • Response
  • 201 response Modified
    • application/json content type Modified
      • OrgAccessDetails property Modified
PUT /organisations/{OrganisationId}/{AuthorisationDomainName}/users/{UserEmailId}/{AuthorisationDomainUserId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • SystemID, UserTypeID properties Added
PUT /users/{UserEmailId}/{TnCId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • OrgAccessDetails property Modified
Added 10
DELETE /references/users/authorisationdomain/systems/{AuthorisationDomainSystemID}
DELETE /references/users/authorisationdomain/usertypes/{AuthorisationDomainUserTypeID}
GET /references/users/authorisationdomain/systems
GET /references/users/authorisationdomain/systems/{AuthorisationDomainSystemID}
GET /references/users/authorisationdomain/usertypes
GET /references/users/authorisationdomain/usertypes/{AuthorisationDomainUserTypeID}
POST /references/users/authorisationdomain/systems
POST /references/users/authorisationdomain/usertypes
PUT /references/users/authorisationdomain/systems/{AuthorisationDomainSystemID}
PUT /references/users/authorisationdomain/usertypes/{AuthorisationDomainUserTypeID}
1.16.1
2 structure changes including:
2 Modifications
Modified 2 Breaking
POST /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/apiresources/{ApiResourceId}/apidiscoveryendpoints
  • Body
  • application/json content type Modified
    • ApiEndpoints property Modified
      • Property is now required
        Breaking
PUT /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/apiresources/{ApiResourceId}/apidiscoveryendpoints/{ApiDiscoveryEndpointId}
  • Body
  • application/json content type Modified
    • ApiEndpoints property Modified
      • Property is now required
        Breaking
2 structure changes including:
2 Modifications
Modified 2 Breaking
POST /organisations/{OrganisationId}/softwarestatements
  • Body
  • application/json content type Modified
    • NotificationWebhookStatus property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
PUT /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}
  • Body
  • application/json content type Modified
    • NotificationWebhookStatus property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking