Skip to content
Authrim

Create a SAML attribute preset.

POST
/api/admin/saml-attribute-presets
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/saml-attribute-presets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "label": "Custom profile attributes", "attributeReleasePolicy": { "attributes": [ { "name": "email", "source": "email" } ] } }'

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
label
required
string
description
string
profile
string
appliesTo
string
Allowed values: sp_attribute_release
attributeReleasePolicy
required
object
attributes
required
Array<object>
object
key
additional properties
Example 
{
  "label": "Custom profile attributes",
  "attributeReleasePolicy": {
    "attributes": [
      {
        "name": "email",
        "source": "email"
      }
    ]
  }
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful JSON response.

Media type application/json
object
preset
required
object
id
required
string
version
required
string
profile
required
string
label
required
string
description
string
stability
string
applicationMode
string
appliesTo
string
isCustom
boolean
attributeReleasePolicy
required
object
key
additional properties
key
additional properties
Example 
{
  "preset": {
    "id": "custom:preset_123",
    "version": "custom:1770000000000",
    "profile": "custom",
    "label": "Custom profile attributes",
    "stability": "custom",
    "applicationMode": "clone_edit",
    "appliesTo": "sp_attribute_release",
    "isCustom": true,
    "attributeReleasePolicy": {
      "attributes": [
        {
          "name": "email",
          "source": "email"
        }
      ]
    }
  }
}

201

Section titled “201 ”

Successful JSON response.

Media type application/json
object
preset
required
object
id
required
string
version
required
string
profile
required
string
label
required
string
description
string
stability
string
applicationMode
string
appliesTo
string
isCustom
boolean
attributeReleasePolicy
required
object
key
additional properties
key
additional properties
Example 
{
  "preset": {
    "id": "custom:preset_123",
    "version": "custom:1770000000000",
    "profile": "custom",
    "label": "Custom profile attributes",
    "stability": "custom",
    "applicationMode": "clone_edit",
    "appliesTo": "sp_attribute_release",
    "isCustom": true,
    "attributeReleasePolicy": {
      "attributes": [
        {
          "name": "email",
          "source": "email"
        }
      ]
    }
  }
}