Skip to main content

Get the authority claims for the given software statement

GET 
/organisations/:OrganisationId/softwarestatements/:SoftwareStatementId/authorityclaims

gets all authority claims attached to this software statement

Request​

Path Parameters

    OrganisationId OrganisationIdrequired

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

    The organisation ID

    SoftwareStatementId SoftwareStatementIdrequired

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

    The software statement 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​

Authority claim for the given Id

Response Headers

  • x-fapi-interaction-id

    string

Schema

  • Array [

    • SoftwareStatementId SoftwareStatementId (string)

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

    Unique Software Statement Id

    SoftwareAuthorityClaimId SoftwareAuthorityClaimId (string)

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

    Unique ID associated with the authority claims for a software statement

    Status StatusEnum (string)

    Possible values: [Active, Inactive]

    Default value: Active

    Current status of this resource

    AuthorisationDomain string

    Possible values: <= 30 characters

    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

  • ]

Loading...