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.14.0
9 structure changes including:
9 Modifications
Modified 9 Breaking
GET /audit
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
GET /organisations/{OrganisationId}/authorisationservers
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • FederationId property Added
GET /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/federation
  • Response
  • 200 response Modified
    • application/json content type Modified
      • content property Modified
GET /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/federation/{FederationConfigId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • FederationId property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /organisations/{OrganisationId}/authorisationservers
  • Body
  • application/json content type Modified
    • FederationId property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • FederationId property Added
POST /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/federation
  • Body
  • application/json content type Modified
    • FederationId property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 201 response Modified
    • application/json content type Modified
      • FederationId property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
PUT /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}
  • Body
  • application/json content type Modified
    • FederationId property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • FederationId property Added
PUT /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/federation/{FederationConfigId}
  • Body
  • application/json content type Modified
    • FederationId property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • FederationId property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
1.13.1
2 structure changes including:
2 Modifications
Modified 2 Breaking
POST /organisations/{OrganisationId}/contacts
  • Body
  • application/json content type Modified
    • PhoneNumber property Modified
      • Property is now required
        Breaking
PUT /organisations/{OrganisationId}/contacts/{ContactId}
  • Body
  • application/json content type Modified
    • PhoneNumber property Modified
      • Property is now required
        Breaking
1 structure change including:
1 Modification
Modified 1 Breaking
POST /clients
  • Response
  • 201 response Modified
    • application/json content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
5 structure changes including:
5 Modifications
Modified 5
GET /organisations/{OrganisationId}/softwarestatements
  • Response
  • 200 response Modified
    • application/json content type Modified
      • TlsClientCertificateBoundAccessTokens property Added
GET /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • TlsClientCertificateBoundAccessTokens property Added
POST /organisations/{OrganisationId}/softwarestatements
  • Body
  • application/json content type Modified
    • TlsClientCertificateBoundAccessTokens property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • TlsClientCertificateBoundAccessTokens property Added
PUT /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}
  • Body
  • application/json content type Modified
    • TlsClientCertificateBoundAccessTokens property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • TlsClientCertificateBoundAccessTokens property Added
PUT /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}/unlock
  • Response
  • 200 response Modified
    • application/json content type Modified
      • TlsClientCertificateBoundAccessTokens property Added
5 structure changes including:
5 Modifications
Modified 5
GET /organisations/{OrganisationId}/softwarestatements
  • Response
  • 200 response Modified
    • application/json content type Modified
      • RelatedAuthorisationServer property Added
GET /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • RelatedAuthorisationServer property Added
POST /organisations/{OrganisationId}/softwarestatements
  • Body
  • application/json content type Modified
    • RelatedAuthorisationServer property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • RelatedAuthorisationServer property Added
PUT /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}
  • Body
  • application/json content type Modified
    • RelatedAuthorisationServer property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • RelatedAuthorisationServer property Added
PUT /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}/unlock
  • Response
  • 200 response Modified
    • application/json content type Modified
      • RelatedAuthorisationServer property Added
1.13.0
3 structure changes including:
3 Modifications
Modified 3
GET /clients
  • Response
  • 200 response Modified
    • application/json content type Modified
      • content property Modified
GET /clients/{ClientId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • claims_in_verified_claims property Added
POST /clients
  • Response
  • 201 response Modified
    • application/json content type Modified
      • claims_in_verified_claims property Added
1 structure change including:
1 Modification
Modified 1 Breaking
GET /users/{UserEmailId}
  • Authentication
  • Godir authorizer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Authorizer authentication method Added
4 structure changes including:
4 Modifications
Modified 4 Breaking
POST /references/certificationtypes
  • Body
  • content type Modified
    • ResourceType, TypeName properties Modified
      • Properties are now required
        Breaking
    • CreatedAt, CreatedBy properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
POST /references/certificationtypes/{TypeID}/variants
  • Body
  • content type Modified
    • CertificationDurationDays, VariantName properties Modified
      • Properties are now required
        Breaking
PUT /references/certificationtypes/{TypeID}
  • Body
  • content type Modified
    • ResourceType, TypeName properties Modified
      • Properties are now required
        Breaking
    • CreatedAt, CreatedBy properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
PUT /references/certificationtypes/{TypeID}/variants/{VariantID}
  • Body
  • content type Modified
    • CertificationDurationDays, VariantName properties Modified
      • Properties are now required
        Breaking
1.12.0
7 structure changes including:
7 Modifications
Modified 7 Breaking
GET /references/certificationtypes
  • Query
  • TypeId query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • typeName, status query parameters Added
GET /references/certificationtypes/{TypeID}/variants
  • Response
  • 200 response Modified
    • content property Modified
  • Query
  • status query parameter Added
GET /references/certificationtypes/{TypeID}/variants/{VariantID}
  • Response
  • 200 response Modified
    • CertificateDurationDays property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • CertificationDurationDays property Added
POST /references/certificationtypes
  • Body
  • content type Modified
    • TypeID property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
POST /references/certificationtypes/{TypeID}/variants
  • Body
  • content type Modified
    • CertificateDurationDays, CreatedAt, CreatedBy, TypeID, VariantID properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • CertificationDurationDays property Added
  • Response
  • 201 response Modified
    • CertificateDurationDays property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • CertificationDurationDays property Added
PUT /references/certificationtypes/{TypeID}
  • Body
  • content type Modified
    • TypeID property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
PUT /references/certificationtypes/{TypeID}/variants/{VariantID}
  • Body
  • content type Modified
    • CertificateDurationDays, CreatedAt, CreatedBy, TypeID, VariantID properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • CertificationDurationDays property Added
  • Response
  • 200 response Modified
    • CertificateDurationDays property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • CertificationDurationDays property Added
2 structure changes including:
2 Modifications
Modified 2 Breaking
GET /audit
  • Authentication
  • Go dir authorizer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Godir authorizer authentication method Added
GET /users/{UserEmailId}
  • Authentication
  • Authorizer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Godir authorizer authentication method Added
5 structure changes including:
1 Addition
4 Modifications
Modified 4
GET /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}/metadata
  • Response
  • 200 response Modified
    • Status property Added
GET /references/authorisationdomainroles/{AuthorisationDomainRoleName}/metadata
  • Response
  • 200 response Modified
    • Status property Added
GET /references/authorisationdomainroles/{AuthorisationDomainRoleName}/metadata/{MetadataId}
  • Response
  • 200 response Modified
    • Status property Added
POST /references/authorisationdomainroles/{AuthorisationDomainRoleName}/metadata
  • Response
  • 201 response Modified
    • Status property Added
Added 1
PUT /references/authorisationdomainroles/{AuthorisationDomainRoleName}/metadata/{MetadataId}
1.11.5
55 structure changes including:
1 Breaking change
30 Additions
24 Modifications
1 Removal
Modified 24
GET /organisations/{OrganisationId}/authorisationservers
  • Response
  • 200 response Modified
    • FederationEndpoint property Added
GET /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}
  • Response
  • 200 response Modified
    • FederationEndpoint property Added
GET /organisations/{OrganisationId}/softwarestatements
  • Response
  • 200 response Modified
    • FederationEndpoint, OriginUri properties Added
GET /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}
  • Response
  • 200 response Modified
    • FederationEndpoint, OriginUri properties Added
GET /organisations/{OrganisationId}/tnchistory
  • Response
  • 200 response Modified
    • content property Modified
GET /references/termsandconditions
  • Response
  • 200 response Modified
    • content property Modified
GET /references/termsandconditions/{TnCId}
  • Response
  • 200 response Modified
    • Version property Added
GET /users/{UserEmailId}
  • Response
  • 200 response Modified
    • DirectoryTermsAndConditionsDetails property Modified
    • CreatedAt, UpdatedAt properties Added
GET /users/{UserEmailId}/history
  • Response
  • 200 response Modified
    • content property Modified
POST /organisations/{OrganisationId}/authorisationservers
  • Response
  • 201 response Modified
    • FederationEndpoint property Added
POST /organisations/{OrganisationId}/conformancetest
  • Body
  • content type Modified
    • Version property Added
POST /organisations/{OrganisationId}/ess/initiatesigning
  • Response
  • 200 response Modified
    • TermsAndConditionsDetail property Modified
POST /organisations/{OrganisationId}/softwarestatements
  • Body
  • content type Modified
    • OriginUri property Added
  • Response
  • 201 response Modified
    • FederationEndpoint, OriginUri properties Added
POST /references/authorities
  • Body
  • content type Modified
    • Status property Added
POST /references/termsandconditions
  • Response
  • 201 response Modified
    • Version property Added
POST /users
  • Response
  • 201 response Modified
    • DirectoryTermsAndConditionsDetails property Modified
    • CreatedAt, UpdatedAt properties Added
PUT /organisations/{OrganisationId}/adminusers/{UserEmailId}
  • Response
  • 400 response Added
PUT /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}
  • Response
  • 200 response Modified
    • FederationEndpoint property Added
PUT /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}
  • Body
  • content type Modified
    • OriginUri property Added
  • Response
  • 200 response Modified
    • FederationEndpoint, OriginUri properties Added
PUT /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}/unlock
  • Response
  • 200 response Modified
    • FederationEndpoint, OriginUri properties Added
PUT /references/authorities/{AuthorityId}
  • Body
  • content type Modified
    • Status property Added
PUT /references/termsandconditions/{TnCId}
  • Response
  • 200 response Modified
    • Version property Added
PUT /users/{UserEmailId}/{TnCId}
  • Response
  • 200 response Modified
    • DirectoryTermsAndConditionsDetails property Modified
    • CreatedAt, UpdatedAt properties Added
GET /organisations/{OrganisationId}
  • Response
  • 200 response Modified
    • TncDetails property Modified
Removed 1 Breaking
DELETE /references/authorities/{AuthorityId}
Added 30
PUT /references/organisationLabels/{OrganisationLabelId}
PUT /references/federations/{FederationId}/metadata-policy/{MetadataPolicyId}
DELETE /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/federation/{FederationConfigId}
DELETE /references/certificationtypes/{TypeID}
DELETE /references/certificationtypes/{TypeID}/variants/{VariantID}
DELETE /references/federations/{FederationId}
DELETE /references/federations/{FederationId}/metadata-policy/{MetadataPolicyId}
GET /audit
GET /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/federation
GET /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/federation/{FederationConfigId}
GET /references/certificationtypes
GET /references/certificationtypes/{TypeID}
GET /references/certificationtypes/{TypeID}/variants
GET /references/certificationtypes/{TypeID}/variants/{VariantID}
GET /references/federations
GET /references/federations/{FederationId}
GET /references/federations/{FederationId}/metadata-policy
GET /references/federations/{FederationId}/metadata-policy/{MetadataPolicyId}
GET /references/organisationLabels
GET /references/organisationLabels/{OrganisationLabelId}
POST /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/federation
POST /references/certificationtypes
POST /references/certificationtypes/{TypeID}/variants
POST /references/federations
POST /references/federations/{FederationId}/metadata-policy
POST /references/organisationLabels
PUT /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/federation/{FederationConfigId}
PUT /references/certificationtypes/{TypeID}
PUT /references/certificationtypes/{TypeID}/variants/{VariantID}
PUT /references/federations/{FederationId}
5 structure changes including:
5 Modifications
Modified 5
GET /organisations/{OrganisationId}/softwarestatements
  • Response
  • 200 response Modified
    • UpdateFailedReason property Added
GET /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}
  • Response
  • 200 response Modified
    • UpdateFailedReason property Added
POST /organisations/{OrganisationId}/softwarestatements
  • Response
  • 201 response Modified
    • UpdateFailedReason property Added
PUT /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}
  • Response
  • 200 response Modified
    • UpdateFailedReason property Added
PUT /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}/unlock
  • Response
  • 200 response Modified
    • UpdateFailedReason property Added
1.9.4
5 structure changes including:
5 Modifications
Modified 5
GET /organisations/{OrganisationId}/softwarestatements
  • Response
  • 200 response Modified
    • UpdateFailed property Added
GET /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}
  • Response
  • 200 response Modified
    • UpdateFailed property Added
POST /organisations/{OrganisationId}/softwarestatements
  • Response
  • 201 response Modified
    • UpdateFailed property Added
PUT /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}
  • Response
  • 200 response Modified
    • UpdateFailed property Added
PUT /organisations/{OrganisationId}/softwarestatements/{SoftwareStatementId}/unlock
  • Response
  • 200 response Modified
    • UpdateFailed property Added
1 structure change including:
1 Modification
Modified 1
PUT /organisations/{OrganisationId}
  • Body
  • content type Modified
    • LogoUri property Added
1.9.3
4 structure changes including:
4 Modifications
Modified 4
GET /organisations
  • Response
  • 200 response Modified
    • content property Modified
GET /organisations/{OrganisationId}
  • Response
  • 200 response Modified
    • OrgDetails property Modified
POST /organisations
  • Body
  • content type Modified
    • LogoUri property Added
  • Response
  • 201 response Modified
    • LogoUri property Added
PUT /organisations/{OrganisationId}
  • Response
  • 200 response Modified
    • LogoUri property Added
1.9.0
4 structure changes including:
1 Breaking change
1 Addition
2 Modifications
1 Removal
Modified 2
POST /organisations/{OrganisationId}/conformancetest
  • Response
  • 201 response Modified
    • errorCount, errors properties Added
POST /references/authorisationdomains
  • Body
  • content type Modified
    • Status property Added
Removed 1 Breaking
DELETE /references/authorisationdomains/{AuthorisationDomainName}
Added 1
PUT /references/authorisationdomains/{AuthorisationDomainName}