Skip to main content

Reference data of all authorisation domain roles

GET 
/references/authorisationdomainroles

get all authorisation domain roles

Request​

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

    domainRole string

    Will return authorisation domain roles with data like the provided authorisationDomainRole

    status string

    Will return authorisation domain roles with data like the provided status

    domain string

    Will return authorisation domain roles with data like the provided authorisationDomain

    type string

    Will return authorisation domain roles with data like the provided roletype

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 data of authorisation domains mapped to an authority

Response Headers

  • x-fapi-interaction-id

    string

Schema

    content

    object[]

  • Array [

    • AuthorisationDomainName string

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

    The authorisation domain name

    AuthorisationDomainRoleName AuthorisationDomainRoleName (string)

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

    The authorisation domain role name

    AuthorisationDomainRoleDescription string

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

    The authorisation domain role description

    RoleType RoleTypeEnum (string)

    Possible values: [Directory, Federation]

    Default value: Federation

    The different types of authorisation domain roles

    Exclusive ExclusiveAuthorisationDomainRole (boolean)

    An organization that claims an exclusive role cannot claim any other roles

    Status StatusEnum (string)

    Possible values: [Active, Inactive]

    Default value: Active

    Current status of this resource

  • ]

    • 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...