Update the status of a given Federation configuration

PUT /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/federation/{FederationConfigId}

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

OrganisationId string Required

The organisation ID

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

The authorisation server Id

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

The federation configuration id

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

application/json

Body

ConfigJson string

JSON containing all Federation Configurations

Format should match the following pattern: ^[^<>]*$.
Status string

The status of the policy

Format should match the following pattern: ^[^<>]*$. Values are active, assignable, pending, or rejected.

Responses

200 application/json

Single federation object
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
- AuthorisationServerId string
  
  Maximum length is 40. Format should match the following pattern: ^[^<>]*$.
- ConfigJson string
  
  JSON containing all Federation Configurations
  
  Format should match the following pattern: ^[^<>]*$.
- FederationConfigId string
  
  Unique Federation Configuration Id
  
  Maximum length is 36. Format should match the following pattern: ^[^<>]*$.
- Status string
  
  The status of the policy
  
  Format should match the following pattern: ^[^<>]*$. Values are active, assignable, pending, or rejected.
- Version integer
  
  Version number of the Federation configuration
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}$.
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 /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/federation/{FederationConfigId}

curl \
 -X PUT https://matls-api.sandbox.raidiam.io/organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/federation/{FederationConfigId} \
 -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 '{"ConfigJson":"string","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
{
  "ConfigJson": "string",
  "Status": "active"
}

Response examples (200)

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

# Payload
{
  "AuthorisationServerId": "string",
  "ConfigJson": "string",
  "FederationConfigId": "string",
  "Status": "active",
  "Version": 42
}

Response examples (400)

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

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