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

Aug 14, 2024

main
1.21.0
Compare
1.21.0

API structure has changed

14 structure changes including:
2 Breaking changes
3 Additions
9 Modifications
2 Removals
Modified 9 Breaking
GET /organisations/{OrganisationId}/adminusers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • OrganisationAdminUser alternative Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • OrganisationAdminUserDetails alternative Added
GET /organisations/{OrganisationId}/adminusers/{UserEmailOrID}
  • Path went from /organisations/{OrganisationId}/adminusers/{UserEmailId} to /organisations/{OrganisationId}/adminusers/{UserEmailOrID} (same operationId)
  • Response
  • 200 response Modified
    • application/json content type Modified
      • OrganisationAdminUser alternative Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • OrganisationAdminUserDetails alternative Added
  • Path
  • UserEmailId path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • UserEmailOrID path parameter Added
GET /organisations/{OrganisationId}/{AuthorisationDomainName}/users/{UserEmailOrID}
  • Path went from /organisations/{OrganisationId}/{AuthorisationDomainName}/users/{UserEmailId} to /organisations/{OrganisationId}/{AuthorisationDomainName}/users/{UserEmailOrID} (same operationId)
  • Path
  • UserEmailId path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • UserEmailOrID path parameter Added
GET /users/{UserEmailOrID}
  • Path went from /users/{UserEmailId} to /users/{UserEmailOrID} (same operationId)
  • Response
  • 200 response Modified
    • application/json content type Modified
      • BasicInformation property Modified
      • DataAdministrator property Added
  • Path
  • UserEmailId path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • UserEmailOrID path parameter Added
GET /users/{UserEmailOrID}/history
  • Path went from /users/{UserEmailId}/history to /users/{UserEmailOrID}/history (same operationId)
  • Path
  • UserEmailId path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • UserEmailOrID path parameter Added
POST /organisations/{OrganisationId}/adminusers
  • Response
  • 201 response Modified
    • application/json content type Modified
      • OrganisationAdminUser alternative Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • OrganisationAdminUserDetails alternative Added
POST /organisations/{OrganisationId}/{AuthorisationDomainName}/users
  • Body
  • application/json content type Modified
    • AuthorisationDomainRole, SystemID, UserTypeID properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • ContactRole, System properties Removed
  • Response
  • 201 response Modified
    • application/json content type Modified
      • AuthorisationDomain, AuthorisationDomainRole, AuthorisationDomainUserId, ContactRole, System, SystemID, UserTypeID properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • UserID property Added
PUT /organisations/{OrganisationId}/adminusers/{UserEmailOrID}
  • Path went from /organisations/{OrganisationId}/adminusers/{UserEmailId} to /organisations/{OrganisationId}/adminusers/{UserEmailOrID} (same operationId)
  • Response
  • 200 response Modified
    • application/json content type Modified
      • OrganisationAdminUser alternative Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • OrganisationAdminUserDetails alternative Added
  • Path
  • UserEmailId path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • UserEmailOrID path parameter Added
PUT /organisations/{OrganisationId}/{AuthorisationDomainName}/users/{UserEmailOrID}/{AuthorisationDomainUserId}
  • Path went from /organisations/{OrganisationId}/{AuthorisationDomainName}/users/{UserEmailId}/{AuthorisationDomainUserId} to /organisations/{OrganisationId}/{AuthorisationDomainName}/users/{UserEmailOrID}/{AuthorisationDomainUserId} (same operationId)
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • AuthorisationDomain, AuthorisationDomainRole, AuthorisationDomainUserId, ContactRole, System, SystemID, UserTypeID properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • UserID property Added
  • Path
  • UserEmailId path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • UserEmailOrID path parameter Added
Removed 2 Breaking
POST /users
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /users/{UserEmailId}/{TnCId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 3
GET /users/data-administrator
POST /users/data-administrator
PUT /users/data-administrator/{UserEmailOrID}