Reference Data of all authorisation domain user types

GET 
/references/users/authorisationdomain/usertypes

get all authorisation domain user types

Request

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

parentRole string

The parent role of this domain role

systemID string

The ID of the system to pair it with

status string

The status of the user types

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

200

All authorisation domain user types paginated

Response Headers

• x-fapi-interaction-id

  string

application/json

Schema

Schema

content

object[]

Array [

AuthorisationDomainUserTypeID AuthorisationDomainUserTypeID (string)

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

Unique authorisation domain user type UUID

Name AuthorisationDomainUserTypeName (string)

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

The name of the authorisation domain user type

Description AuthorisationDomainUserTypeDescription (string)

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

The description of the authorisation domain user type

SystemID AuthorisationDomainSystemID (string)

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

Unique authorisation domain system UUID

ParentRole AuthorisationDomainUserTypeID (string)

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

Unique authorisation domain user type UUID

DirectoryAccess AuthorisationDomainUserTypeDirectoryAccess (boolean)

If the user type grants read access to the directory

ReceiveEmailNotifications ReceiveEmailNotifications (boolean)

If the user type should receive organisation update email notifications

OrganisationCertificatesAccess AccessEnum (string)

Possible values: [Read, Write, Administrator, None]

Default value: Read

OrganisationContactsAccess AccessEnum (string)

Possible values: [Read, Write, Administrator, None]

Default value: Read

DomainUserAccess AccessEnum (string)

Possible values: [Read, Write, Administrator, None]

Default value: Read

SoftwareStatementAccess AccessEnum (string)

Possible values: [Read, Write, Administrator, None]

Default value: Read

AuthorisationServerAccess AccessEnum (string)

Possible values: [Read, Write, Administrator, None]

Default value: Read

TermsAndConditionsAccess AccessEnum (string)

Possible values: [Read, Write, Administrator, None]

Default value: Read

Status StatusEnum (string)

Possible values: [Active, Inactive]

Default value: Active

Current status of this resource

]

totalPages integer
totalSize integer

pageable

object

number integer

Page number

sort

object

sorted boolean

orderBy

object[]

Array [

property string

Name of the property used for sorting

direction string

Possible values: [ASC, DESC]

Direction of sort, i.e. ascending or descending

ignoreCase boolean

Was the case ignored

ascending boolean

Whether ascending

]

size integer

Size of the page

offset integer

Offset

sorted boolean

Is the page sorted

unpaged boolean

Is this an unpaged response

numberOfElements integer
size integer
offset integer
empty boolean
pageNumber integer

Example (from schema)

{
  "content": [
    {
      "AuthorisationDomainUserTypeID": "string",
      "Name": "string",
      "Description": "string",
      "SystemID": "string",
      "ParentRole": "string",
      "DirectoryAccess": true,
      "ReceiveEmailNotifications": true,
      "OrganisationCertificatesAccess": "Read",
      "OrganisationContactsAccess": "Read",
      "DomainUserAccess": "Read",
      "SoftwareStatementAccess": "Read",
      "AuthorisationServerAccess": "Read",
      "TermsAndConditionsAccess": "Read",
      "Status": "Active"
    }
  ],
  "totalPages": 0,
  "totalSize": 0,
  "pageable": {
    "number": 0,
    "sort": {
      "sorted": true,
      "orderBy": [
        {
          "property": "createdAt",
          "direction": "ASC",
          "ignoreCase": true,
          "ascending": true
        }
      ]
    },
    "size": 0,
    "offset": 0,
    "sorted": true,
    "unpaged": true
  },
  "numberOfElements": 0,
  "size": 0,
  "offset": 0,
  "empty": true,
  "pageNumber": 0
}

401

Unauthorized

Response Headers

• x-fapi-interaction-id

  string

403

Forbidden

Response Headers

• x-fapi-interaction-id

  string

406

Not Acceptable

Response Headers

• x-fapi-interaction-id

  string

429

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

Response Headers

• x-fapi-interaction-id

  string

500

Internal Server Error

Response Headers

• x-fapi-interaction-id

  string

502

Bad Gateway

Response Headers

• x-fapi-interaction-id

  string

504

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

Response Headers

• x-fapi-interaction-id

  string

Loading...