Skip to content
Authrim

List federation trust sources.

GET
/api/admin/field-mapping/federation-trust-sources
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/admin/field-mapping/federation-trust-sources \
  --header 'Authorization: Bearer <token>'

Lists SAML federation trust sources and metadata configuration summaries for the tenant.

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Federation trust source list response.

Media type application/json
object
federationTrustSources
required
Array<object>
object
id
required
string
tenantId
required
string
sourceType
required
string
Allowed values: saml_aggregate saml_metadata saml_federation
sourceKey
required
string
displayName
required
string
lifecycleState
required
string
protocolPayload
Any of:
object
description
string | null
metadataUrl
string | null format: uri
metadataUrlPatterns
Array<string>
policy
string
Allowed values: strict warn disabled
polling
object
mode
required
string
Allowed values: automatic manual
intervalSeconds
required
integer
>= 900 <= 604800
nextRefreshAt
integer
lastAttemptAt
integer
lastSuccessAt
integer
consecutiveFailures
integer
sourceState
string
Allowed values: healthy stale error expired missing identity_change_pending
lastErrorCode
string
etag
string
lastModified
string
validatorSourceUrl
string format: uri
acceptedValidUntil
string format: date-time
suspendedByMetadataSync

True when metadata lifecycle automation disabled the provider.

boolean
key
additional properties
runtimeResolution
object
mode
required

Inventory_only stores verified entities without using them for authentication. automatic permits runtime entityID resolution subject to this policy.

string
Allowed values: inventory_only automatic
roles
required
Array<string>
unique items
Allowed values: saml_idp saml_sp
priority
integer
0 >= -1000 <= 1000
idpFieldMappingSetId

Required when automatic resolution includes saml_idp.

string
spFieldMappingSetId

Required when automatic resolution includes saml_sp.

string
defaultAttributePresetId
string
Allowed values: basic.v1 academic_publisher.v1 enterprise_saas.v1 research_federation.v1
registrationAuthorities
Array<string>
<= 100 items unique items
entityCategoryPolicy
object
defaultDecision
required
string
Allowed values: allow deny
rules
required
Array<object>
<= 100 items
object
entityCategory
required
string
decision
required
string
Allowed values: allow deny
attributePresetId
string
Allowed values: basic.v1 academic_publisher.v1 enterprise_saas.v1 research_federation.v1
key
additional properties
key
additional properties
key
additional properties
certificates
Array<object>
object
key
additional properties
key
additional properties
createdAt
integer
updatedAt
integer
snapshotHash
string
key
additional properties
key
additional properties
Example 
{
  "federationTrustSources": [
    {
      "sourceType": "saml_aggregate",
      "protocolPayload": {
        "policy": "strict",
        "polling": {
          "mode": "automatic",
          "sourceState": "healthy"
        },
        "runtimeResolution": {
          "mode": "inventory_only",
          "roles": [
            "saml_idp"
          ],
          "priority": 0,
          "defaultAttributePresetId": "basic.v1",
          "entityCategoryPolicy": {
            "defaultDecision": "allow",
            "rules": [
              {
                "decision": "allow",
                "attributePresetId": "basic.v1"
              }
            ]
          }
        }
      }
    }
  ]
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Section titled “404 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

409

Section titled “409 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Section titled “500 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}