Connect logo
API Changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification

Topics

  • Introduction
  • Authentication

Endpoints

  • Users
    • All admin users for the given organisation GET
    • Create an organisation admin user POST
    • Gets details of an organisation admin user by their email address GET
    • Reactivate or deactivate an organisation admin user by their email address PUT
    • All users for the given authorisation domain GET
    • Create an authorisation domain user POST
    • Authorisation Domain user details GET
    • All data administrators GET
    • Create a data administrator POST
    • Toggle active status of users data administrator role PUT
    • All super users GET
    • Details of the user GET
    • TnC history of the user GET
  • Organisations
    • Get all organisations that the logged in user is authorised to retrieve from trusted services GET
    • Post a new organisation in the directory. POST
    • Get the given organisations details GET
    • Amend the given organisations details PUT
    • Delete an organisation by changing its status to "Withdrawn" DELETE
    • Get all Authorisation Servers for the given organisation GET
    • Create an Authorisation Server for the given organisation POST
    • Get an authorisation server by Id GET
    • Update an authorisation server PUT
    • Delete an Authorisation Server DELETE
    • Get all Api Resources for the given Authorisation Server GET
    • Create an Api Resource for the given organisation and Authorisation Server POST
    • Get an authorisation server API resource by Id GET
    • Update an Api Resource for the given organisation and Authorisation Server PUT
    • Delete an authorisation server API resource by Id DELETE
    • Get all Api Discovery Endpoints for the given Authorisation Server and Api Version GET
    • Create an Api Discovery Endpoint for the given organisation and Authorisation Server and Api Version POST
    • Get an authorisation server API discovery endpoint by Id GET
    • Update an Api Discovery Endpoint for the given organisation, Authorisation Server and Api Version PUT
    • Delete an Api Discovery Endpoint for the given organisation, Authorisation Server and Api Version DELETE
    • Get an authorisation server API resource metadata GET
    • Edit an api resource metadata entry for the given api resource PUT
    • Get all certifications for given authorisation server GET
    • Post a certification for the given authorisation server POST
    • Get a certification by Id GET
    • Update the given certification PUT
    • Remove a certification with the given certification Id DELETE
    • Get an authorisation server API resource by Id and returns the latest family status GET
    • Get all authorisation server federation configuration by Authorisation Server Id GET
    • Create an authorisation server federation configuration POST
    • Get an authorisation server federation configuration by Federation Config Id GET
    • Update the status of a given Federation configuration PUT
    • Delete an Authorisation Server Federation Configuration DELETE
    • Get the authority claims for the given organisation GET
    • Post an authority claim POST
    • Get an authority claim by Id GET
    • Update an authority claim for the given Id PUT
    • Delete an authority claim DELETE
    • Get an authority claims authorisations GET
    • Post an authority claims authorisations POST
    • Get a claim authorisation GET
    • Remove an authorisation from authority claims DELETE
    • Get the authority domain claims for the given organisation GET
    • Post an authority domain claim POST
    • Get an authority domain claim by Id GET
    • Update an authority domain claim by Id PUT
    • Deactivate an authority domain claim by Id DELETE
    • Get the certificates for the given organisation GET
    • Retrieve a certificate with the given CertificateOrKeyId GET
    • Revoke or remove a certificate with the given CertificateOrKeyId providing a revoke reason PUT
    • Get the certificates of the given OrganisationCertificateType for the given organisation GET
    • Store or create a new certificate of the given OrganisationCertificateType for the given organisation POST
    • Create and execute a Conformance Suite test plan for the given organisation POST
    • Get the contacts for the given organisation GET
    • Post a contact for the given organisation POST
    • Get a contact by Id GET
    • Update the contacts for the given organisation PUT
    • Remove a contact in an organisation with the given contact id DELETE
    • This API initiates ESS signing process by an org admin POST
    • This API marks the current envelope as reissued and allows a new one to be started POST
    • Get all software statements for the given organisation GET
    • Create a software statement POST
    • Get a specific software statement GET
    • Update a software statement by Id. PUT
    • Delete or revoke a software statement with the given softwarestatementID DELETE
    • Get a Software Statement Assertion for the given SoftwareStatementID. GET
    • Get the authority claims for the given software statement GET
    • Post an authority claim for a software statement POST
    • Get an authority claim by Id GET
    • Update an authority claim for the given Id PUT
    • Get certificates for the given software statement GET
    • Add a key or create a new certificate for the given software statement POST
    • Get the certificate of the given type and ID for the given software statement GET
    • Update a software statement certificate with the given CertificateOrKeyId e.g. revoke reason PUT
    • Get all certifications for given Software Statement. GET
    • Post a certification for the given Software Statement POST
    • Get a certification by Id GET
    • Update the given certification PUT
    • Remove a certification with the given certification Id DELETE
    • Get all metadata associated with a software statement GET
    • Unlock a software statement. PUT
    • Get all TnC data of the given organisation GET
  • Reference Data
    • Reference data of all authorisation domain roles GET
    • Create an authorisation domain role POST
    • Get an authorisation domain role by name GET
    • Update an authorisation domain role by name PUT
    • Deactivate an authorisation domain role by Name DELETE
    • Get metadata associated with an authorisation domain role GET
    • Create a metadata record associated with an authorisation domain role POST
    • Get metadata associated with an authorisation domain role GET
    • Change the status of a metadata object that is associated with an authorisation domain role PUT
    • Delete a metadata object that is associated with an authorisation domain role DELETE
    • Reference data of all authorisation domains GET
    • Create an authorisation domain POST
    • Get an authorisation domain by Name GET
    • Update an authorisation domain by Name PUT
    • Reference data of all authorisation domain roles GET
    • Create an authorisation domain role POST
    • Get an authorisation domain role by name GET
    • Update an authorisation domain role by name PUT
    • Deactivate an authorisation domain role by Name DELETE
    • Get metadata associated with an authorisation domain role GET
    • Create a metadata record associated with an authorisation domain role POST
    • Get metadata associated with an authorisation domain role GET
    • Change the status of a metadata object that is associated with an authorisation domain role PUT
    • Delete a metadata object that is associated with an authorisation domain role DELETE
    • Reference Data of all authorities GET
    • Create a reference authority POST
    • Get a reference authority by Id GET
    • Update a reference authority by Id PUT
    • Reference data of all authorisation domains for an Authority ID GET
    • Map an authorisation domain to an authority POST
    • Get an authority authorisation domain by Id GET
    • Activate an authority authorisation domain by Id PUT
    • Deactivate an authority authorisation domain by Id DELETE
    • Mappings of authorities with authorisation domains GET
    • Get certification types GET
    • Set certification types POST
    • Get a specific certification type by ID GET
    • Update certification types PUT
    • Delete a certification type DELETE
    • Get certification type variants GET
    • Set certification type variant POST
    • Get certification type variant by ID GET
    • Update certification type variant by ID PUT
    • Delete a certification type variant DELETE
    • Get all federations GET
    • Create a new federation POST
    • Get a federation by id GET
    • Update a federation PUT
    • Delete a federation DELETE
    • Get the metadata policy for a federation GET
    • Create a new metadata policy POST
    • Get a metadata policy GET
    • Update a metadata policy PUT
    • Delete a metadata policy DELETE
    • Returns all flags configured at a reference data level GET
    • Create a new flag POST
    • Returns a specific flag configured at a reference data level GET
    • Updates an existing flag PUT
    • Delete an existing flag DELETE
    • All terms and conditions GET
    • Create TnC POST
    • Get details for a TnC document GET
    • Update the content of a TnC document PUT
    • Deactivate a TnC document DELETE
    • Reference Data of all authorisation domain systems GET
    • Create Reference Data for a new authorisation domain system POST
    • Get specific record for authorisation domain system GET
    • Update Reference Data for a new authorisation domain system PUT
    • Remove Reference Data for a new authorisation domain system DELETE
    • Reference Data of all authorisation domain user types GET
    • Create Reference Data for a new authorisation domain user type POST
    • Get specific record for authorisation domain user type GET
    • Update Reference Data for a new authorisation domain user type PUT
    • Remove Reference Data for a new authorisation domain user type DELETE
  • Software Statements
    • Get all registered clients GET
    • Refresh/rebuild the registered clients data POST
    • Get details for one client GET
  • Audit History
    • Fetches audit history based on query parameters GET
  • Public
    • Update an authorisation domain user record by the unique identifier PUT
  • Global Search
    • Get the top 10 results based on a partial/full match of identifier GET
Powered by Bump.sh

Global Search