Skip to main content

Post an authority claim for a software statement

POST 
/organisations/:OrganisationId/softwarestatements/:SoftwareStatementId/authorityclaims

attaches an authority claim to a software statement from the list of authority claims attached to the organisation

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

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.

Body

required

Software Statement authority claim's payload

    Status StatusEnum (string)required

    Possible values: [Active, Inactive]

    Default value: Active

    Current status of this resource

    AuthorisationDomain stringrequired

    Possible values: non-empty and <= 30 characters

    Authorisation domain for the authority

    Role AuthorisationDomainRoleName (string)required

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

    The authorisation domain role name

Responses​

Authority claim for the given Id

Response Headers

  • x-fapi-interaction-id

    string

Schema

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