Skip to main content

Get an authorisation server by Id

GET 
/organisations/:OrganisationId/authorisationservers/:AuthorisationServerId

get a specific authorisation server

Request​

Path Parameters

    OrganisationId OrganisationIdrequired

    Possible values: non-empty and <= 40 characters, Value must match regular expression ^[^<>]*$

    The organisation ID

    AuthorisationServerId AuthorisationServerIdrequired

    Possible values: <= 40 characters, Value must match regular expression ^[^<>]*$

    The authorisation server Id

Header Parameters

    x-fapi-auth-date string

    Possible values: Value must match regular expression ^(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)$

    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

    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.

Responses​

Authorisation server response

Response Headers

  • x-fapi-interaction-id

    string

Schema

    ApiResources

    object[]

  • Array [

    • ApiDiscoveryEndpoints

    object[]

  • Array [

    • ApiDiscoveryId ApiEndpointId (string)

    Possible values: <= 40 characters, Value must match regular expression ^[^<>]*$

    The unique ID of an Api discovery endpoint resource

    ApiEndpoint ApiEndpoint (string)

    Possible values: <= 255 characters, Value must match regular expression ^(http://|https://).*

    A compliant URI

  • ]

    • ApiMetadata object

  • ]

    • AuthorisationServerCertifications

    object[]

  • Array [

    • CertificationStartDate CertificationStartDate (string)

    Possible values: Value must match regular expression ^[0-3][0-9]/[0-1][0-9]/2([0-9]{3})$

    JSONDatetime of certification start date

    CertificationExpirationDate CertificationExpirationDate (string)

    Possible values: Value must match regular expression ^[^<>]*$

    JSONDatetime of certification expiration date

    CertificationId AuthorisationServerCertificationId (string)

    Possible values: non-empty and <= 40 characters, Value must match regular expression ^[^<>]*$

    Unique ID associated with the auth server certification

    AuthorisationServerId AuthorisationServerId (string)

    Possible values: <= 40 characters, Value must match regular expression ^[^<>]*$

    CertificationStatus CertificationStatusEnum (string)

    Possible values: [Awaiting Certification, Certified, Deprecated, Rejected, Warning, Self-Certified]

    Default value: Awaiting Certification

    The different types of certification status

    ProfileVariant ProfileVariant (string)

    Possible values: Value must match regular expression ^[^<>]*$

    Certification variant

    ProfileType ProfileType (string)

    Possible values: Value must match regular expression ^[^<>]*$

    Certification type

    ProfileVersion number

    The version number of the certification

    CertificationURI uri

    Possible values: <= 500 characters, Value must match regular expression ^(https://).*

    Link to the certifation package. Example https://github.com/Open[Domain]/conformance/blob/main/submissions/functional/business/1.0.3/api-business-customer.zip

    Status StatusEnum (string)

    Possible values: [Active, Inactive]

    Default value: Active

    Current status of this resource

  • ]

    • Flags

    object[]

  • Array [

    • Id FlagID (string)

    Possible values: <= 40 characters, Value must match regular expression ^[^<>]*$

    Unique ID of the flag

    CreatedAt date-time
    UpdatedAt date-time

  • ]

    • Status StatusEnum (string)

    Possible values: [Active, Inactive]

    Default value: Active

    Current status of this resource

    AuthorisationServerId AuthorisationServerId (string)

    Possible values: <= 40 characters, Value must match regular expression ^[^<>]*$

    AutoRegistrationNotificationWebhook uri

    Possible values: <= 255 characters, Value must match regular expression ^(http://|https://).*

    A compliant URI to subscribe to the software statement onboarding webhook

    AutoRegistrationSupported AutoRegistrationSupported (boolean)

    Flag to denote if this authorisation server supports the automatic onboarding of software statement clients

    CreatedAt date-time
    CustomerFriendlyDescription CustomerFriendlyDescription (string)

    Possible values: non-empty and <= 255 characters, Value must match regular expression ^[^<>]*$

    A customer friendly description

    CustomerFriendlyLogoUri uri

    Possible values: Value must match regular expression ^(http://|https://).*.(svg|png|jpg|jpeg)$|(data:image/[a-zA-Z0-9;+=-]+,[A-Za-z0-9+/]*={0,2})$

    A compliant URI

    CustomerFriendlyName CustomerFriendlyName (string)

    Possible values: non-empty and <= 255 characters, Value must match regular expression ^[^<>]*$

    DeprecatedDate date

    Authorisation Server support/deprecation end date

    DeveloperPortalUri urinullable

    Possible values: <= 255 characters, Value must match regular expression ^(http://|https://).*

    A compliant URI

    FederationEndpoint uri

    Possible values: <= 255 characters, Value must match regular expression ^(https://).*

    The federation endpoint for the Authorisation Server

    FederationId uuid

    Possible values: <= 36 characters

    The ID of the federation

    Issuer uri

    An issuer value pulled from the well-known endpoint

    NotificationWebhook uri

    Possible values: <= 255 characters, Value must match regular expression ^(http://|https://).*

    A compliant URI

    NotificationWebhookAddedDate date

    Creation date

    NotificationWebhookStatus NotificationWebhookStatusEnum (string)

    Possible values: [Pending, Confirmed, Deactivated]

    Default value: Pending

    OpenIDDiscoveryDocument OpenIDDiscoveryDocument (string)

    Possible values: <= 255 characters, Value must match regular expression ^(http://|https://).*

    A compliant URI

    OrganisationId OrganisationId (string)

    Possible values: non-empty and <= 40 characters, Value must match regular expression ^[^<>]*$

    Unique ID associated with the organisation

    ParentAuthorisationServerId AuthorisationServerId (string)

    Possible values: <= 40 characters, Value must match regular expression ^[^<>]*$

    PayloadSigningCertLocationUri PayloadSigningCertLocationUri (string)

    Possible values: <= 255 characters, Value must match regular expression ^(http://|https://).*

    A compliant URI

    RetirementDate date

    Authorisation Server Retirement date

    SupersededByAuthorisationServerId AuthSupersededById (string)

    Possible values: <= 40 characters, Value must match regular expression ^[^<>]*$

    Authorisation Server ID which replaces the current auth server

    SupportsCiba SupportsCiba (boolean)

    Flag to denote if this authorisation server supports Client Initiated Backchannel Authentication

    SupportsDCR SupportsDCR (boolean)

    Flag to denote if this authorisation server supports Dynamic Client Registration

    SupportsRedirect SupportsRedirect (boolean)

    Flag to denote if this authorisation server supports redirect

    TermsOfServiceUri urinullable

    Possible values: <= 255 characters, Value must match regular expression ^(http://|https://).*

    A compliant URI

Loading...