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 structure change including:
1 Modification
Modified 1 Breaking
GET /audit
  • Query
  • OrganisationIdQueryParameter query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • organisationId query parameter Added
1.23.0
13 structure changes including:
13 Modifications
Modified 13
GET /clients/{ClientId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • software_version property Modified
        • Property is now deprecated
GET /organisations/{OrganisationId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • OrgDetails property Modified
        • Tags property Removed
GET /organisations/{OrganisationId}/authorityclaims
  • Response
  • 200 response Modified
    • application/json content type Modified
      • UniqueTechnicalIdenifier property Modified
        • Property is now deprecated
      • UniqueTechnicalIdentifiers property Added
GET /organisations/{OrganisationId}/authorityclaims/{OrganisationAuthorityClaimId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • UniqueTechnicalIdenifier property Modified
        • Property is now deprecated
      • UniqueTechnicalIdentifiers property Added
GET /organisations/{OrganisationId}/softwarestatements
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Version property Modified
        • Property is now deprecated
      • SoftwareVersion property Added
GET /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Version property Modified
        • Property is now deprecated
      • SoftwareVersion property Added
POST /organisations
  • Response
  • 201 response Modified
    • application/json content type Modified
      • Tags property Removed
POST /organisations/{OrganisationId}/authorityclaims
  • Body
  • application/json content type Modified
    • UniqueTechnicalIdenifier property Modified
      • Property is now deprecated
    • UniqueTechnicalIdentifiers property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • UniqueTechnicalIdenifier property Modified
        • Property is now deprecated
      • UniqueTechnicalIdentifiers property Added
POST /organisations/{OrganisationId}/softwarestatements
  • Body
  • application/json content type Modified
    • SoftwareVersion property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • Version property Modified
        • Property is now deprecated
      • SoftwareVersion property Added
PUT /organisations/{OrganisationId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Tags property Removed
PUT /organisations/{OrganisationId}/authorityclaims/{OrganisationAuthorityClaimId}
  • Body
  • application/json content type Modified
    • UniqueTechnicalIdenifier property Modified
      • Property is now deprecated
    • UniqueTechnicalIdentifiers property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • UniqueTechnicalIdenifier property Modified
        • Property is now deprecated
      • UniqueTechnicalIdentifiers property Added
PUT /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}
  • Body
  • application/json content type Modified
    • SoftwareVersion property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Version property Modified
        • Property is now deprecated
      • SoftwareVersion property Added
PUT /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}/unlock
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Version property Modified
        • Property is now deprecated
      • SoftwareVersion property Added
1.22.5
11 structure changes including:
11 Modifications
Modified 11
GET /organisations/{OrganisationId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • OrgDetails property Modified
        • Flags property Modified
GET /organisations/{OrganisationId}/softwarestatements
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Flags property Modified
        • AccessLevel property Added
GET /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Flags property Modified
        • AccessLevel property Added
GET /references/flags/{FlagID}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • AccessLevel property Added
POST /organisations
  • Response
  • 201 response Modified
    • application/json content type Modified
      • Flags property Modified
        • AccessLevel property Added
POST /organisations/{OrganisationId}/softwarestatements
  • Response
  • 201 response Modified
    • application/json content type Modified
      • Flags property Modified
        • AccessLevel property Added
POST /references/flags
  • Body
  • application/json content type Modified
    • AccessLevel property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • AccessLevel property Added
PUT /organisations/{OrganisationId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Flags property Modified
        • AccessLevel property Added
PUT /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Flags property Modified
        • AccessLevel property Added
PUT /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}/unlock
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Flags property Modified
        • AccessLevel property Added
PUT /references/flags/{FlagID}
  • Body
  • application/json content type Modified
    • AccessLevel property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • AccessLevel property Added
14 structure changes including:
14 Modifications
Modified 14 Breaking
GET /organisations/{OrganisationId}/authorisationservers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Status property Added
GET /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Status property Added
GET /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/certifications
  • Response
  • 200 response Modified
    • application/json content type Modified
      • CertificationStatus property Added
GET /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/certifications/{AuthorisationServerCertificationId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • CertificationStatus property Added
GET /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}/certifications
  • Response
  • 200 response Modified
    • application/json content type Modified
      • CertificationStatus property Added
GET /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}/certifications/{SoftwareStatementCertificationId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • CertificationStatus property Added
POST /organisations/{OrganisationId}/authorisationservers
  • Body
  • application/json content type Modified
    • Status property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • Status property Added
POST /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/apiresources
  • Body
  • application/json content type Modified
    • Status property Modified
      • Property is now required
        Breaking
POST /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/certifications
  • Body
  • application/json content type Modified
    • CertificationStartDate, CertificationURI, ProfileType, ProfileVariant, ProfileVersion properties Modified
      • Properties are now required
        Breaking
    • CertificationStatus property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • CertificationStatus property Added
POST /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}/certifications
  • Body
  • application/json content type Modified
    • CertificationStartDate, CertificationURI, ProfileType, ProfileVariant, ProfileVersion properties Modified
      • Properties are now required
        Breaking
    • CertificationStatus property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • CertificationStatus property Added
PUT /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}
  • Body
  • application/json content type Modified
    • Status property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Status property Added
PUT /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/apiresources/{ApiResourceId}
  • Body
  • application/json content type Modified
    • CertificationStatus, Status properties Modified
      • Properties are now required
        Breaking
PUT /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/certifications/{AuthorisationServerCertificationId}
  • Body
  • application/json content type Modified
    • CertificationStartDate, CertificationURI, ProfileType, ProfileVariant, ProfileVersion properties Modified
      • Properties are now required
        Breaking
    • CertificationStatus property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • CertificationStatus property Added
PUT /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}/certifications/{SoftwareStatementCertificationId}
  • Body
  • application/json content type Modified
    • CertificationStartDate, CertificationURI, ProfileType, ProfileVariant, ProfileVersion properties Modified
      • Properties are now required
        Breaking
    • CertificationStatus property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • CertificationStatus property Added
15 structure changes including:
4 Breaking changes
11 Modifications
4 Removals
Modified 11
GET /organisations/{OrganisationId}/adminusers
  • Query
  • page, size, sort query parameters Added
GET /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/certifications
  • Query
  • page, size, sort query parameters Added
GET /organisations/{OrganisationId}/authorityclaims
  • Query
  • page, size, sort query parameters Added
GET /organisations/{OrganisationId}/authorityclaims/{OrganisationAuthorityClaimId}/authorisations
  • Query
  • page, size, sort query parameters Added
GET /organisations/{OrganisationId}/certificates
  • Query
  • page, size, sort query parameters Added
GET /organisations/{OrganisationId}/certificates/{OrganisationCertificateType}
  • Query
  • page, size, sort query parameters Added
GET /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}/authorityclaims
  • Query
  • page, size, sort query parameters Added
GET /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}/certificates
  • Query
  • page, size, sort query parameters Added
GET /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}/certifications
  • Query
  • page, size, sort query parameters Added
GET /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}/metadata
  • Query
  • page, size, sort query parameters Added
GET /references/authorisationdomainroles/{AuthorisationDomainRoleName}/metadata
  • Query
  • page, size, sort query parameters Added
Removed 4 Breaking
GET /references/organisationLabels
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /references/organisationLabels/{OrganisationLabelId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /references/organisationLabels
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /references/organisationLabels/{OrganisationLabelId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
1.22.4
3 structure changes including:
3 Modifications
Modified 3
GET /references/users/authorisationdomain/usertypes/{AuthorisationDomainUserTypeID}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • TermsAndConditionsAccess property Added
POST /references/users/authorisationdomain/usertypes
  • Body
  • application/json content type Modified
    • TermsAndConditionsAccess property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • TermsAndConditionsAccess property Added
PUT /references/users/authorisationdomain/usertypes/{AuthorisationDomainUserTypeID}
  • Body
  • application/json content type Modified
    • TermsAndConditionsAccess property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • TermsAndConditionsAccess property Added
1.22.3
1 structure change including:
1 Modification
Modified 1
PUT /references/authorisationdomainroles/{AuthorisationDomainRoleName}
  • Body
  • application/json content type Modified
    • Status property Added
1.22.2
2 structure changes including:
2 Modifications
Modified 2
POST /organisations/{OrganisationId}/authorityclaims
  • Body
  • application/json content type Modified
    • RegistrationId property Modified
      • Property is no longer required
PUT /organisations/{OrganisationId}/authorityclaims/{OrganisationAuthorityClaimId}
  • Body
  • application/json content type Modified
    • RegistrationId property Modified
      • Property is no longer required
1.22.1
1 structure change including:
1 Modification
Modified 1 Breaking
GET /organisations/{OrganisationId}/{AuthorisationDomainName}/users
  • Path
  • AuthorisationDomainRoleName path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Query
  • AuthorisationDomainRoleName query parameter Added
1.22.0
5 structure changes including:
5 Modifications
Modified 5 Breaking
GET /organisations/{OrganisationId}/{AuthorisationDomainName}/users
  • Path
  • AuthorisationDomainRoleName path parameter Added
GET /references/federations/{FederationId}/metadata-policy
  • Query
  • page, size, sort query parameters Added
PUT /organisations/{OrganisationId}/adminusers/{UserEmailOrID}
  • Body
  • application/json content type Modified
    • Status property Modified
      • Property is now required
        Breaking
PUT /organisations/{OrganisationId}/{AuthorisationDomainName}/users/{UserEmailOrID}/{AuthorisationDomainUserId}
  • Body
  • application/json content type Modified
    • Status property Modified
      • Property is now required
        Breaking
PUT /users/data-administrator/{UserEmailOrID}
  • Body
  • application/json content type Modified
    • Status property Modified
      • Property is now required
        Breaking
6 structure changes including:
6 Modifications
Modified 6
GET /clients/{ClientId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • homepage_uri property Added
GET /organisations/{OrganisationId}/softwarestatements
  • Response
  • 200 response Modified
    • application/json content type Modified
      • HomepageUri property Added
GET /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • HomepageUri property Added
POST /organisations/{OrganisationId}/softwarestatements
  • Body
  • application/json content type Modified
    • HomepageUri property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • HomepageUri property Added
PUT /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}
  • Body
  • application/json content type Modified
    • HomepageUri property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • HomepageUri property Added
PUT /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}/unlock
  • Response
  • 200 response Modified
    • application/json content type Modified
      • HomepageUri property Added
1.21.0
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}
1.20.7
5 structure changes including:
5 Modifications
Modified 5
GET /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/apiresources
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Query
  • status query parameter Added
GET /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/apiresources/{ApiResourceId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Status property Added
GET /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/familystatus
  • Response
  • 200 response Modified
    • application/json content type Modified
POST /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/apiresources
  • Body
  • application/json content type Modified
    • Status property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • Status property Added
PUT /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/apiresources/{ApiResourceId}
  • Body
  • application/json content type Modified
    • Status property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Status property Added
1.20.6
2 structure changes including:
2 Additions
Added 2
GET /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/apiresources/{ApiResourceId}/metadata
PUT /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/apiresources/{ApiResourceId}/metadata
1.20.5
2 structure changes including:
1 Breaking change
1 Addition
1 Removal
Removed 1 Breaking
GET /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}/certificates/{CertificateOrKeyId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 1
GET /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}/certificates/{SoftwareStatementCertificateOrKeyType}/{CertificateOrKeyId}
1.20.6
2 structure changes including:
1 Breaking change
1 Addition
1 Removal
Removed 1 Breaking
GET /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}/certificates/{SoftwareStatementCertificateOrKeyType}/{CertificateOrKeyId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 1
GET /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}/certificates/{CertificateOrKeyId}