Get an authorisation domain by Name

GET /references/authorisationdomains/{AuthorisationDomainName}

oAuth

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.

Path parameters

AuthorisationDomainName string Required

Authorisation Domain Name. Eg:PSD2

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

Responses

200 application/json

Data of an authorisation domain mapped to an authority
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
- AuthorisationDomainDescription string
  
  The authorisation domain description
  
  Format should match the following pattern: ^[^<>]*$.
- AuthorisationDomainName string
  
  The authorisation domain name
  
  Format should match the following pattern: ^[^<>]*$.
- AuthorisationDomainRegion string
  
  The authorisation domain region
  
  Format should match the following pattern: ^[^<>]*$.
- Status string
  
  Current status of this resource
  
  Values are Active or Inactive. Default value is Active.
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}$.
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}$.

GET /references/authorisationdomains/{AuthorisationDomainName}

curl \
 -X GET https://matls-api.sandbox.raidiam.io/references/authorisationdomains/{AuthorisationDomainName} \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "x-fapi-auth-date: string" \
 -H "x-fapi-customer-ip-address: string" \
 -H "x-fapi-interaction-id: string" \
 -H "x-customer-user-agent: string"

Response examples (200)

# Headers
x-fapi-interaction-id: 73cac523-d3ae-2289-b106-330a6218710d

# Payload
{
  "AuthorisationDomainDescription": "string",
  "AuthorisationDomainName": "string",
  "AuthorisationDomainRegion": "string",
  "Status": "Active"
}

Response examples (400)

# Headers
x-fapi-interaction-id: 73cac523-d3ae-2289-b106-330a6218710d

# Payload
{
  "errors": [
    "string"
  ]
}

Response examples (404)

# Headers
x-fapi-interaction-id: 73cac523-d3ae-2289-b106-330a6218710d

# Payload
{
  "errors": [
    "string"
  ]
}