Skip to content

Set SSO SAML configuration for specific application in the organization

Request

Set SSO SAML configuration for specific application in the organization. Creates a new configuration if it does not exist, or updates an existing one.

Required permissions: organizations:edit, orgs:edit.

Security
AdminAccessToken
Path
organization_idstringrequired

ID of the organization

app_idstringrequired

ID of the application

Bodyapplication/jsonrequired
service_providerobjectrequired
identity_providerobjectrequired
namestringrequired

Name of the SSO configuration

enabledboolean

Indicates whether the SSO configuration is enabled

Default:true
sso_signup_enabledboolean

Indicates whether public signup through SSO is allowed

group_role_mappingobject

Group-to-role mapping configuration

curl -i -X PUT \
  'https://api.sbx.transmitsecurity.io/cis/v1/organizations/{organization_id}/applications/{app_id}/sso/saml/set' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "service_provider": {
      "default_redirect_uri": "",
      "acs_url": "string"
    },
    "identity_provider": {
      "entity_id": "string",
      "sso_url": "string",
      "signing_certificates": [
        "string"
      ],
      "nameid_type": "string"
    },
    "name": "string",
    "enabled": true,
    "sso_signup_enabled": true,
    "group_role_mapping": {
      "enabled": false,
      "group_claim_name": "groups",
      "mappings": [
        {
          "idp_group_name": "string",
          "role_ids": [
            "string"
          ]
        }
      ],
      "default_role_ids": [
        "string"
      ]
    }
  }'

Responses

Bodyapplication/json
resultobjectrequired
Response
{
  "result": {}
}