Skip to main content

Post an authority domain claim

POST 
/organisations/:OrganisationId/authoritydomainclaims

creates a new mapping between an authority / authorisation domain mapping and an organisation

Request​

Path Parameters

    OrganisationId OrganisationIdrequired

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

    The organisation 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

Authority Authorisation Domain mapping request

    AuthorisationDomainName stringrequired

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

    The authorisation domain name

    AuthorityId stringrequired

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

    The Authority ID

    RegistrationId string

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

    The registration ID

Responses​

All authority to domain mappings data

Response Headers

  • x-fapi-interaction-id

    string

Schema

    OrganisationAuthorityDomainClaimId string

    The unique org authority domain claim ID

    AuthorisationDomainName string

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

    The authorisation domain name

    AuthorityId string

    The GUID of the Authority

    AuthorityName string

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

    The name of the Authority

    RegistrationId string

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

    The registration ID

    Status StatusEnum (string)

    Possible values: [Active, Inactive]

    Default value: Active

    Current status of this resource

Loading...