Skip to main content

All users for the given authorisation domain

GET 
/organisations/:OrganisationId/:AuthorisationDomainName/users

Get all organisation authorisation domain users

Request​

Path Parameters

    OrganisationId OrganisationIdrequired

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

    The organisation ID

    AuthorisationDomainName AuthorisationDomainNamerequired

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

    Authorisation Domain Name. Eg:PSD2

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

    AuthorisationDomainRoleName AuthorisationDomainRoleName

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

    Authorisation Domain Role Name. Eg:TPP

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​

All users belonging to an authorisation domain

Response Headers

  • x-fapi-interaction-id

    string

Schema

    content

    object[]

  • Array [

    • AuthorisationDomainUserId string

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

    Unique record ID

    AuthorisationDomain string

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

    The authorisation domain for this user

    AuthorisationDomainRole AuthorisationDomainRoleName (string)

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

    The authorisation domain role name

    UserTypeID AuthorisationDomainUserTypeID (string)

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

    Unique authorisation domain user type UUID

    ContactRole AuthorisationDomainUserTypeName (string)

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

    The name of the authorisation domain user type

    SystemID AuthorisationDomainSystemID (string)

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

    Unique authorisation domain system UUID

    System AuthorisationDomainSystemName (string)

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

    The name of the authorisation domain user type

  • ]

    • totalPages integer
    totalSize integer

    pageable

    object

    number integer

    Page number

    sort

    object

    sorted boolean

    orderBy

    object[]

  • Array [

    • property string

    Name of the property used for sorting

    direction string

    Possible values: [ASC, DESC]

    Direction of sort, i.e. ascending or descending

    ignoreCase boolean

    Was the case ignored

    ascending boolean

    Whether ascending

  • ]

    • size integer

    Size of the page

    offset integer

    Offset

    sorted boolean

    Is the page sorted

    unpaged boolean

    Is this an unpaged response

    numberOfElements integer
    size integer
    offset integer
    empty boolean
    pageNumber integer
Loading...