Skip to main content

Get an authority claim by Id

GET 
/organisations/:OrganisationId/authorityclaims/:OrganisationAuthorityClaimId

get a specific authority claim object

Request​

Path Parameters

    OrganisationId OrganisationIdrequired

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

    The organisation ID

    OrganisationAuthorityClaimId OrganisationAuthorityClaimIdrequired

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

    The Authority claims ID for an organisation

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​

Authority claim for the given Id

Schema

    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

    OrganisationId OrganisationId (string)

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

    Unique ID associated with the organisation

    OrganisationAuthorityClaimId OrganisationAuthorityClaimId (string)

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

    Unique ID associated with the authority claims

    AuthorityId AuthorityId (string)

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

    Unique ID associated with the Authorisation reference schema

    Status StatusEnum (string)

    Possible values: [Active, Inactive]

    Default value: Active

    Current status of this resource

    AuthorisationDomain string

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

    Authorisation Domain for the authority

    Role AuthorisationDomainRoleName (string)

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

    The authorisation domain role name

    RegistrationId string

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

    Registration ID for the organisation

    UniqueTechnicalIdenifier string[]deprecated

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

    Legacy and will eventually be removed - please use UniqueTechnicalIdentifiers instead

    UniqueTechnicalIdentifiers UniqueTechnicalIdentifier (string)[]

    Possible values: <= 16

Loading...