Reference Data of all authorisation domain systems

GET /references/users/authorisationdomain/systems

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.

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

Responses

200 application/json

All authorisation domain user systems paginated
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
- empty boolean
- numberOfElements integer
- offset integer
- pageNumber integer
- pageable object
  
  Additional properties are allowed.
  
  Hide pageable attributes Show pageable attributes object
  
  number integer
  
  Page number
  
  offset integer
  
  Offset
  
  size integer
  
  Size of the page
  
  sort object
  
  Additional properties are allowed.
  
  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
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}$.
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/users/authorisationdomain/systems

curl \
 -X GET https://matls-api.sandbox.raidiam.io/references/users/authorisationdomain/systems \
 -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
{
  "empty": true,
  "numberOfElements": 42,
  "offset": 42,
  "pageNumber": 42,
  "pageable": {
    "number": 42,
    "offset": 42,
    "size": 42,
    "sort": {
      "orderBy": [
        {
          "ascending": true,
          "direction": "ASC",
          "ignoreCase": true,
          "property": "createdAt"
        }
      ],
      "sorted": true
    },
    "sorted": true,
    "unpaged": true
  },
  "size": 42,
  "totalPages": 42,
  "totalSize": 42
}