Skip to main content

Get the authority claims for the given organisation

GET 
/organisations/:OrganisationId/authorityclaims

get all authorisation domain roles an organisation has made claim to

Request​

Path Parameters

    OrganisationId OrganisationIdrequired

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

    The organisation ID

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

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 authority claims for the organisation

Response Headers

  • x-fapi-interaction-id

    string

Schema

  • Array [

    • Authorisations

    object[]

  • Array [

    • Status StatusEnum (string)

    Possible values: [Active, Inactive]

    Default value: Active

    Current status of this resource

    MemberState string

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

    Abbreviated states information i.e. GB, IE, NL etc

  • ]

    • RoleType string

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

    Type of authorisation domain role

    Exclusive ExclusiveAuthorisationDomainRole (boolean)

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

    Metadata object

    Possible values: <= 255 characters

    Authorisation domain role metadata

  • ]

Loading...