Sign in

v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB
AuthN Mappings

List all AuthN Mappings

List all AuthN Mappings in the org.

get/api/v2/authn_mappings

Query parameters

page[size]integer
Example:10

Size for a given page. The maximum allowed value is 100.

page[number]integer

Specific page number to return.

sort'created_at' | '-created_at' | 'role_id' | '-role_id' | 'saml_assertion_attribute_id' | '-saml_assertion_attribute_id' | 'role.name' | '-role.name' | 'saml_assertion_attribute.attribute_key' | '-saml_assertion_attribute.attribute_key' | 'saml_assertion_attribute.attribute_value' | '-saml_assertion_attribute.attribute_value'

Sorting options for AuthN Mappings.

Sort AuthN Mappings depending on the given field.

filterstring

Filter all mappings by the given string.

resource_type'role' | 'team'

The type of resource being mapped to.

Filter by mapping resource type. Defaults to "role" if not specified.

Response

OK

Example response

{
  "data": [
    {
      "attributes": {
        "attribute_key": "member-of",
        "attribute_value": "Development",
        "saml_assertion_attribute_id": "0"
      },
      "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d",
      "relationships": {
        "role": {
          "data": {
            "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d",
            "type": "roles"
          }
        },
        "saml_assertion_attribute": {
          "data": {
            "id": "0",
            "type": "saml_assertion_attributes"
          }
        },
        "team": {
          "data": {
            "id": "f9bb8444-af7f-11ec-ac2c-da7ad0900001",
            "type": "team"
          }
        }
      },
      "type": "authn_mappings"
    }
  ],
  "included": [
    {
      "attributes": {
        "attribute_key": "member-of",
        "attribute_value": "Development"
      },
      "id": "0",
      "type": "saml_assertion_attributes"
    }
  ]
}