Headers

• x-fapi-auth-date string

  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

  Format should match the following pattern: ^(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)$.

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

Path parameters

• AuthorisationDomainUserTypeID string Required

  A UUID denoting a specific authorisation domain user type

  Maximum length is 40. Format should match the following pattern: ^[^<>]*$.

Responses

• 200 application/json

  Authorisation domain user type

  Hide headers attribute Show headers attribute

  • x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

    Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

  Hide response attributes Show response attributes object

  • AuthorisationDomainUserTypeID string

    Unique authorisation domain user type UUID

    Maximum length is 40. Format should match the following pattern: ^[^<>]*$.

  • AuthorisationServerAccess string

    Values are Read, Write, Administrator, or None. Default value is Read.

  • Description string

    The description of the authorisation domain user type

    Maximum length is 255. Format should match the following pattern: ^[^<>]*$.

  • DirectoryAccess boolean

    If the user type grants read access to the directory

  • DomainUserAccess string

    Values are Read, Write, Administrator, or None. Default value is Read.

  • Name string

    The name of the authorisation domain user type

    Maximum length is 255. Format should match the following pattern: ^[^<>]*$.

  • OrganisationCertificatesAccess string

    Values are Read, Write, Administrator, or None. Default value is Read.

  • OrganisationContactsAccess string

    Values are Read, Write, Administrator, or None. Default value is Read.

  • ParentRole string

    Unique authorisation domain user type UUID

    Maximum length is 40. Format should match the following pattern: ^[^<>]*$.

  • ReceiveEmailNotifications boolean

    If the user type should receive organisation update email notifications

  • SoftwareStatementAccess string

    Values are Read, Write, Administrator, or None. Default value is Read.

  • Status string

    Current status of this resource

    Values are Active or Inactive. Default value is Active.

  • SystemID string

    Unique authorisation domain system UUID

    Maximum length is 40. Format should match the following pattern: ^[^<>]*$.

  • TermsAndConditionsAccess string

    Values are Read, Write, Administrator, or None. Default value is Read.

• 401

  Unauthorized

  Hide headers attribute Show headers attribute

  • x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

    Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

• 403

  Forbidden

  Hide headers attribute Show headers attribute

  • x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

    Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

• 406

  Not Acceptable

  Hide headers attribute Show headers attribute

  • x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

    Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

• 429

  Too many requests, maximum capacity reached. Requests are now throttled.

  Hide headers attribute Show headers attribute

  • x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

    Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

• 500

  Internal Server Error

  Hide headers attribute Show headers attribute

  • x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

    Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

• 502

  Bad Gateway

  Hide headers attribute Show headers attribute

  • x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

    Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

• 504

  Upstream timeout, insufficient capacity to serve request. More capacity being brought online. Please try again.

  Hide headers attribute Show headers attribute

  • x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

    Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.