Update a metadata policy

PUT /references/federations/{FederationId}/metadata-policy/{MetadataPolicyId}

oAuth

Path parameters

FederationId string(uuid) Required

The federation id

Maximum length is 36.
MetadataPolicyId string Required

The metadata policy id

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

application/json

Body Required

Policy string Required

The json of the metadata policy

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

The status of the policy

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

The type of the metadata policy

Format should match the following pattern: ^[^<>]*$. Values are openid_relying_party, openid_provider, oauth_authorization_server, oauth_client, oauth_resource, or federation_entity.

Responses

200 application/json

Details of the federation metadata policy item
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
- CreatedAt string(date-time)
- FederationID string(uuid)
  
  The ID of the federation
  
  Maximum length is 36.
- Policy string
  
  The json of the metadata policy
  
  Format should match the following pattern: ^[^<>]*$.
- ReferenceID string
  
  The id of the metadata policy
  
  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.
- Type string
  
  The type of the metadata policy
  
  Format should match the following pattern: ^[^<>]*$. Values are openid_relying_party, openid_provider, oauth_authorization_server, oauth_client, oauth_resource, or federation_entity.
- Version integer
  
  The version of the metadata policy
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}$.
404 application/json

Not found
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
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}$.
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/federations/{FederationId}/metadata-policy/{MetadataPolicyId}

curl \
 -X PUT https://matls-api.sandbox.raidiam.io/references/federations/{FederationId}/metadata-policy/{MetadataPolicyId} \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"Policy":"string","Status":"active","Type":"openid_relying_party"}'

Request examples

{
  "Policy": "string",
  "Status": "active",
  "Type": "openid_relying_party"
}

Response examples (200)

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

# Payload
{
  "CreatedAt": "2025-05-04T09:42:00+00:00",
  "FederationID": "string",
  "Policy": "string",
  "ReferenceID": "string",
  "Status": "active",
  "Type": "openid_relying_party",
  "Version": 42
}

Response examples (400)

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

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

Response examples (404)

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

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