Update an authorisation domain role by name

PUT /references/authorisationdomainroles/{AuthorisationDomainRoleName}

oAuth

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

AuthorisationDomainRoleName string Required

Authorisation Domain Role Name. Eg:TPP

Minimum length is 1, maximum length is 60. Format should match the following pattern: ^[^<>]*$.

application/json

Body Required

AuthorisationDomainName string Required

The authorisation domain name

Minimum length is 1. Format should match the following pattern: ^[^<>]*$.
AuthorisationDomainRoleDescription string

The authorisation domain role description

Format should match the following pattern: ^[^<>]*$. Default value is empty.
AuthorisationDomainRoleName string Required

The authorisation domain role name

Minimum length is 1, maximum length is 60. Format should match the following pattern: ^[^<>]*$.
Exclusive boolean

An organization that claims an exclusive role cannot claim any other roles
RoleType string

The different types of authorisation domain roles

Values are Directory or Federation. Default value is Federation.
Status string

Current status of this resource

Values are Active or Inactive. Default value is Active.

Responses

200 application/json

Role data
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
- AuthorisationDomainName string
  
  The authorisation domain name
  
  Format should match the following pattern: ^[^<>]*$.
- AuthorisationDomainRoleDescription string
  
  The authorisation domain role description
  
  Format should match the following pattern: ^[^<>]*$.
- AuthorisationDomainRoleName string
  
  The authorisation domain role name
  
  Minimum length is 1, maximum length is 60. Format should match the following pattern: ^[^<>]*$.
- Exclusive boolean
  
  An organization that claims an exclusive role cannot claim any other roles
- RoleType string
  
  The different types of authorisation domain roles
  
  Values are Directory or Federation. Default value is Federation.
- Status string
  
  Current status of this resource
  
  Values are Active or Inactive. Default value is Active.
400 application/json

Bad Request
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 attribute Show response attribute object
- errors array[string]
  
  Validation Error messages
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}$.
409

Conflict
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}$.

PUT /references/authorisationdomainroles/{AuthorisationDomainRoleName}

curl \
 -X PUT https://matls-api.sandbox.raidiam.io/references/authorisationdomainroles/PAGTO \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -H "x-fapi-auth-date: string" \
 -H "x-fapi-customer-ip-address: string" \
 -H "x-fapi-interaction-id: string" \
 -H "x-customer-user-agent: string" \
 -d '{"AuthorisationDomainName":"string","AuthorisationDomainRoleDescription":"","AuthorisationDomainRoleName":"PAGTO","Exclusive":true,"RoleType":"Federation","Status":"Active"}'

Request examples

# Headers
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-fapi-interaction-id: string
x-customer-user-agent: string

# Payload
{
  "AuthorisationDomainName": "string",
  "AuthorisationDomainRoleDescription": "",
  "AuthorisationDomainRoleName": "PAGTO",
  "Exclusive": true,
  "RoleType": "Federation",
  "Status": "Active"
}

Response examples (200)

# Headers
x-fapi-interaction-id: 73cac523-d3ae-2289-b106-330a6218710d

# Payload
{
  "AuthorisationDomainName": "string",
  "AuthorisationDomainRoleDescription": "string",
  "AuthorisationDomainRoleName": "PAGTO",
  "Exclusive": true,
  "RoleType": "Federation",
  "Status": "Active"
}

Response examples (400)

# Headers
x-fapi-interaction-id: 73cac523-d3ae-2289-b106-330a6218710d

# Payload
{
  "errors": [
    "string"
  ]
}