Skip to main content

Create an authorisation domain

POST 
/references/authorisationdomains

creates an authorisation domain

Request​

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

Authorisation Domain creation request

    AuthorisationDomainName stringrequired

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

    The authorisation domain name

    AuthorisationDomainRegion stringrequired

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

    The authorisation domain region

    AuthorisationDomainDescription string

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

    The authorisation domain description

    Status StatusEnum (string)

    Possible values: [Active, Inactive]

    Default value: Active

    Current status of this resource

Responses​

Data of an authorisation domain mapped to an authority

Response Headers

  • x-fapi-interaction-id

    string

Schema

    AuthorisationDomainName string

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

    The authorisation domain name

    AuthorisationDomainRegion string

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

    The authorisation domain region

    AuthorisationDomainDescription string

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

    The authorisation domain description

    Status StatusEnum (string)

    Possible values: [Active, Inactive]

    Default value: Active

    Current status of this resource

Loading...