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 uuidrequired

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

200

Authorisation server response

Response Headers

• x-fapi-interaction-id

  string

application/json

Schema

Schema

AutoRegistrationSupported AutoRegistrationSupported (boolean)required

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

AutoRegistrationNotificationWebhook uri

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

A compliant URI to subscribe to the software statement onboarding webhook

CustomerFriendlyDescription CustomerFriendlyDescription (string)required

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

A customer friendly description

CustomerFriendlyLogoUri urirequired

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)required

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

DeveloperPortalUri urinullable

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

A compliant URI

TermsOfServiceUri urinullable

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

A compliant URI

NotificationWebhook uri

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

A compliant URI

OpenIDDiscoveryDocument OpenIDDiscoveryDocument (string)

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

A compliant URI

PayloadSigningCertLocationUri PayloadSigningCertLocationUri (string)

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

A compliant URI

ParentAuthorisationServerId uuid

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

DeprecatedDate date

Authorisation Server support/deprecation end date

RetirementDate date

Authorisation Server Retirement date

SupersededByAuthorisationServerId uuid

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

Authorisation Server ID which replaces the current auth server

FederationId uuid

Possible values: <= 36 characters

The ID of the federation

OmitFromEcosystem OmitFromEcosystem (boolean)

'Denotes if the entity should be omitted from the subject ecosystem. For example, an authorisation server with this flag set to true would not appear in the participants endpoint or OpenID Federation offerings'

AuthorisationServerId uuid

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

OrganisationId DeprecatedOrganisationId (string)deprecated

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

Unique ID associated with the organisation

Issuer uri

An issuer value pulled from the well-known endpoint

FederationEndpoint uri

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

The federation endpoint for the Authorisation Server

NotificationWebhookAddedDate date

Creation date

NotificationWebhookStatus NotificationWebhookStatusEnum (string)

Possible values: [Pending, Confirmed, Deactivated]

Default value: Pending

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

CreatedAt date-time
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

Name FlagName (string)required

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

The name of this flag

Description FlagDescription (string)

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

The description of this flag

Type FlagType (string)required

Possible values: [Organisation, Software_Statement, Authorisation_Server]

The type of this tag

Value FlagValue (string)required

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

The value of this flag

Status StatusEnum (string)required

Possible values: [Active, Inactive]

Default value: Active

Current status of this resource

AccessLevel FlagAccessLevel (integer)required

The access level of a flag as a number. The higher the number, the more sensitive it is

]

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

ApiResourceId ApiResourceId (string)

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

The unique ID of an Api version resource

ApiVersion string

Possible values: Value must match regular expression ^([0-9]+\.[0-9]+\.[0-9]+)$|^([0-9]+)$|^([0-9]+\.[0-9]+)$

The version number of the API

FamilyComplete boolean

Denotes whether or not the api resource has had all related api endpoints published

ApiCertificationUri 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

CertificationStatus CertificationStatusEnum (string)

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

Default value: Awaiting Certification

The different types of certification status

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

ApiFamilyType ApiFamilyType (string)

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

The type of API this record describes

Status StatusEnum (string)

Possible values: [Active, Inactive]

Default value: Active

Current status of this resource

]

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 uuid

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

]

Example (from schema)

{
  "AutoRegistrationSupported": false,
  "AutoRegistrationNotificationWebhook": "string",
  "CustomerFriendlyDescription": "string",
  "CustomerFriendlyLogoUri": "string",
  "CustomerFriendlyName": "string",
  "DeveloperPortalUri": "string",
  "TermsOfServiceUri": "string",
  "NotificationWebhook": "string",
  "OpenIDDiscoveryDocument": "string",
  "PayloadSigningCertLocationUri": "string",
  "ParentAuthorisationServerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "DeprecatedDate": "2021-01-30",
  "RetirementDate": "2023-12-30",
  "SupersededByAuthorisationServerId": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6",
  "FederationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "OmitFromEcosystem": false,
  "AuthorisationServerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "Issuer": "string",
  "FederationEndpoint": "string",
  "NotificationWebhookAddedDate": "2021-01-30",
  "NotificationWebhookStatus": "Pending",
  "SupportsCiba": false,
  "SupportsDCR": false,
  "SupportsRedirect": false,
  "CreatedAt": "2024-07-29T15:51:28.071Z",
  "Status": "Active",
  "Flags": [
    {
      "Id": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6",
      "CreatedAt": "2024-07-29T15:51:28.071Z",
      "UpdatedAt": "2024-07-29T15:51:28.071Z",
      "Name": "string",
      "Description": "string",
      "Type": "Organisation",
      "Value": "string",
      "Status": "Active",
      "AccessLevel": 0
    }
  ],
  "ApiResources": [
    {
      "ApiDiscoveryEndpoints": [
        {
          "ApiDiscoveryId": "string",
          "ApiEndpoint": "https://raidiam.io/cb"
        }
      ],
      "ApiMetadata": {},
      "ApiResourceId": "string",
      "ApiVersion": "string",
      "FamilyComplete": true,
      "ApiCertificationUri": "string",
      "CertificationStatus": "Awaiting Certification",
      "CertificationStartDate": "string",
      "CertificationExpirationDate": "string",
      "ApiFamilyType": "string",
      "Status": "Active"
    }
  ],
  "AuthorisationServerCertifications": [
    {
      "CertificationStartDate": "string",
      "CertificationExpirationDate": "string",
      "CertificationId": "string",
      "AuthorisationServerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "CertificationStatus": "Awaiting Certification",
      "ProfileVariant": "FAPI Adv. OP w/ MTLS",
      "ProfileType": "Redirect",
      "ProfileVersion": 0,
      "CertificationURI": "string",
      "Status": "Active"
    }
  ]
}

401

Unauthorized

Response Headers

• x-fapi-interaction-id

  string

403

Forbidden

Response Headers

• x-fapi-interaction-id

  string

404

Not found

Response Headers

• x-fapi-interaction-id

  string

application/json

Schema

Schema

errors string[]

Validation Error messages

Example (from schema)

{
  "errors": [
    "string"
  ]
}

429

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

Response Headers

• x-fapi-interaction-id

  string

500

Internal Server Error

Response Headers

• x-fapi-interaction-id

  string

502

Bad Gateway

Response Headers

• x-fapi-interaction-id

  string

504

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

Response Headers

• x-fapi-interaction-id

  string

Loading...