Headers

• x-fapi-auth-date string

  The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

  Format should match the following pattern: ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$.

• x-fapi-customer-ip-address string

  The PSU's IP address if the PSU is currently logged in with the TPP.

• x-fapi-interaction-id string

  An RFC4122 UID used as a correlation id.

• x-customer-user-agent string

  Indicates the user-agent that the PSU is using.

Query parameters

• page integer

  The page number to return of the result set

• size integer

  The size of the pages to return

• sort string

  The field name to sort

• resourceType string

  The resource type to filter by

• typeName string

  The type name to search by

• status string

  The status to filter by

Responses

• 200 application/json

  Certification Type

  Hide headers attribute Show headers attribute

  • x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

    Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

  Hide response attributes Show response attributes object

  • content array[object]
    Hide content attributes Show content attributes object

    • CreatedAt string(date-time)
    • CreatedBy string

      User who created the certification type

      Format should match the following pattern: ^[^<>]*$.

    • Description string

      Description of the certification type

      Format should match the following pattern: ^[^<>]*$.

    • ResourceType string

      Values are apiDiscoveryEndpoint, apiResource, authorisationDomainSystem, authorisationDomainUserType, authorisationServer, authorisationServerCertification, authorisationServerFlag, certificationType, certificationManager, certificationTypeVariant, contact, dataAdministrator, domain, domainUser, federation, federationMetadataPolicy, flag, jwk, organisation, organisationAdmin, organisationAuthorityClaim, organisationAuthorityClaimAuthorisations, organisationAuthorityDomainClaim, organisationCertificate, organisationFlag, organisationTermsAndConditions, referenceAuthority, referenceAuthorisationDomain, referenceAuthorisationDomainRole, referenceAuthorisationDomainRoleMetadata, referenceAuthorityAuthorisationDomain, referenceTermsAndConditions, softwareStatement, softwareStatementAuthorityRoleClaim, softwareStatementCertification, softwareStatementFlag, softwareStatementJwk, ssoConfiguration, ssoConfigurationVersion, superUser, user, userGroup, userGroupIdpBinding, userGroupOrganisationBinding, userGroupPermissionBinding, userGroupUserMapping, or webhookSubscriptionForDeletion.

    • Status string

      Current status of this resource

      Values are Active or Inactive. Default value is Active.

    • TypeID string

      Type ID of the certification

      Maximum length is 40. Format should match the following pattern: ^[^<>]*$.

    • TypeName string

      Type name of the certification

      Format should match the following pattern: ^[^<>]*$.

  • empty boolean
  • numberOfElements integer
  • offset integer
  • pageNumber integer
  • pageable object
    Hide pageable attributes Show pageable attributes object

    • number integer

      Page number

    • offset integer

      Offset

    • size integer

      Size of the page

    • sort object
      Hide sort attributes Show sort attributes object

      • orderBy array[object]
        Hide orderBy attributes Show orderBy attributes object

        • ascending boolean

          Whether ascending

        • direction string

          Direction of sort, i.e. ascending or descending

          Values are ASC or DESC.

        • ignoreCase boolean

          Was the case ignored

        • property string

          Name of the property used for sorting

      • sorted boolean
    • sorted boolean

      Is the page sorted

    • unpaged boolean

      Is this an unpaged response

  • size integer
  • totalPages integer
  • totalSize integer
• 400 application/json

  Bad Request

  Hide headers attribute Show headers attribute

  • x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

    Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

  Hide response attribute Show response attribute object

  • errors array[string]

    Validation Error messages

• 401

  Unauthorized

  Hide headers attribute Show headers attribute

  • x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

    Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

• 403

  Forbidden

  Hide headers attribute Show headers attribute

  • x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

    Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

• 404 application/json

  Not found

  Hide headers attribute Show headers attribute

  • x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

    Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

  Hide response attribute Show response attribute object

  • errors array[string]

    Validation Error messages

• 406

  Not Acceptable

  Hide headers attribute Show headers attribute

  • x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

    Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

• 409

  Conflict

  Hide headers attribute Show headers attribute

  • x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

    Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

• 429

  Too many requests, maximum capacity reached. Requests are now throttled.

  Hide headers attribute Show headers attribute

  • x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

    Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

• 500

  Internal Server Error

  Hide headers attribute Show headers attribute

  • x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

    Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

• 502

  Bad Gateway

  Hide headers attribute Show headers attribute

  • x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

    Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

• 504

  Upstream timeout, insufficient capacity to serve request. More capacity being brought online. Please try again.

  Hide headers attribute Show headers attribute

  • x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

    Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.