Skip to main content

Update Reference Data for a new authorisation domain user type

PUT 
/references/users/authorisationdomain/usertypes/:AuthorisationDomainUserTypeID

update authorisation domain user type

Request​

Path Parameters

    AuthorisationDomainUserTypeID AuthorisationDomainUserTypeIDrequired

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

    A UUID denoting a specific authorisation domain user type

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

Create or update an authorisation domain user type

    Name AuthorisationDomainUserTypeName (string)required

    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

    ParentRole AuthorisationDomainUserTypeID (string)

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

    Unique authorisation domain user type UUID

    SystemID AuthorisationDomainSystemID (string)required

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

    Unique authorisation domain system UUID

    DirectoryAccess AuthorisationDomainUserTypeDirectoryAccess (boolean)required

    If the user type grants read access to the directory

    ReceiveEmailNotifications ReceiveEmailNotifications (boolean)required

    If the user type should receive organisation update email notifications

    OrganisationCertificatesAccess AccessEnum (string)required

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

    Default value: Read

    OrganisationContactsAccess AccessEnum (string)required

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

    Default value: Read

    DomainUserAccess AccessEnum (string)required

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

    Default value: Read

    SoftwareStatementAccess AccessEnum (string)required

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

    Default value: Read

    AuthorisationServerAccess AccessEnum (string)required

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

    Default value: Read

    TermsAndConditionsAccess AccessEnum (string)required

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

    Default value: Read

    Status StatusEnum (string)required

    Possible values: [Active, Inactive]

    Default value: Active

    Current status of this resource

Responses​

Authorisation domain user type

Response Headers

  • x-fapi-interaction-id

    string

Schema

    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

Loading...