Create a new federation

POST /references/federations
application/json

Body Required

  • Contacts array[string]

    The contacts of the federation

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

  • Description string

    The description of the federation

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

  • HomepageUri string

    The homepage uri of the federation

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

  • LogoUri string

    The logo uri of the federation

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

  • Name string Required

    The name of the federation

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

  • OrganizationName string

    The organization name of the federation

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

  • PolicyUri string

    The policy uri of the federation

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

  • RemoteTrustAnchor string(uri)

    The uri for a remote trust anchor

    Maximum length is 255.

  • Status string

    Current status of this resource

    Values are Active or Inactive. Default value is Active.

Responses

  • 201 application/json

    Details of the federation 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
    • Contacts array[string]

      The contacts of the federation

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

    • CreatedAt string(date-time)
    • Description string

      The description of the federation

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

    • FederationFetchEndpoint string(uri)

      The fetch endpoint of the federation

      Maximum length is 255.

    • FederationListEndpoint string(uri)

      The list endpoint of the federation

      Maximum length is 255.

    • FederationResolveEndpoint string(uri)

      The resolve endpoint of the federation

      Maximum length is 255.

    • FederationTrustMarkListEndpoint string(uri)

      The trust mark list endpoint of the federation

      Maximum length is 255.

    • FederationTrustMarkStatusEndpoint string(uri)

      The trust mark status endpoint of the federation

      Maximum length is 255.

    • HomepageUri string

      The homepage uri of the federation

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

    • LogoUri string

      The logo uri of the federation

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

    • Name string

      The name of the federation

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

    • OrganizationName string

      The organization name of the federation

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

    • PolicyUri string

      The policy uri of the federation

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

    • ReferenceID string(uuid)

      The ID of the federation

      Maximum length is 36.

    • RemoteTrustAnchor string(uri)

      The uri for a remote trust anchor

      Maximum length is 255.

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

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

POST /references/federations
curl \
 --request POST 'https://matls-api.sandbox.raidiam.io/references/federations' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"Contacts":["string"],"Description":"string","HomepageUri":"string","LogoUri":"string","Name":"string","OrganizationName":"string","PolicyUri":"string","RemoteTrustAnchor":"https://example.com","Status":"Active"}'
Request examples
{
  "Contacts": [
    "string"
  ],
  "Description": "string",
  "HomepageUri": "string",
  "LogoUri": "string",
  "Name": "string",
  "OrganizationName": "string",
  "PolicyUri": "string",
  "RemoteTrustAnchor": "https://example.com",
  "Status": "Active"
}
Response examples (201)
# Headers
x-fapi-interaction-id: 73cac523-d3ae-2289-b106-330a6218710d

# Payload
{
  "Contacts": [
    "string"
  ],
  "CreatedAt": "2025-05-04T09:42:00Z",
  "Description": "string",
  "FederationFetchEndpoint": "https://example.com",
  "FederationListEndpoint": "https://example.com",
  "FederationResolveEndpoint": "https://example.com",
  "FederationTrustMarkListEndpoint": "https://example.com",
  "FederationTrustMarkStatusEndpoint": "https://example.com",
  "HomepageUri": "string",
  "LogoUri": "string",
  "Name": "string",
  "OrganizationName": "string",
  "PolicyUri": "string",
  "ReferenceID": "string",
  "RemoteTrustAnchor": "https://example.com",
  "Status": "Active"
}
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"
  ]
}