Create SAML Application | API Reference

POST

/v1/mgmt/sso/idp/app/saml/create

Create SAML Application within a project

This endpoint creates a SAML Application within your Descope project.

Endpoint Authentication

Use authorization bearer header with the following format:

Authorization: Bearer \<ProjectId:ManagementKey\>

Authorization

`Authorization`
Required
Bearer <token>

< Project ID >:< Management Key > as bearer

In: header

Request Body

`id`string

`name`string

`description`string

`enabled`boolean

`logo`string

`loginPageUrl`string

`useMetadataInfo`boolean

`metadataUrl`string

`entityId`string

`acsUrl`string

`certificate`string

`attributeMapping`array<object>

`groupsMapping`array<object>

`acsAllowedCallbacks`array<string>

`subjectNameIdType`string

`subjectNameIdFormat`string

`defaultRelayState`string

`forceAuthentication`boolean

`logoutRedirectUrl`string

`errorRedirectURL`string

Status code	Description
`200`	OK

curl -X POST "https://api.descope.com/v1/mgmt/sso/idp/app/saml/create" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <ProjectId:ManagementKey>" \
  -d '{
  "id": "string",
  "name": "string",
  "description": "string",
  "enabled": true,
  "logo": "string",
  "loginPageUrl": "string",
  "useMetadataInfo": true,
  "metadataUrl": "string",
  "entityId": "string",
  "acsUrl": "string",
  "certificate": "string",
  "attributeMapping": [
    {
      "name": "string",
      "type": "string",
      "value": "string"
    }
  ],
  "groupsMapping": [
    {
      "name": "string",
      "type": "string",
      "filterType": "string",
      "value": "string",
      "roles": [
        {
          "id": "string",
          "name": "string"
        }
      ]
    }
  ],
  "acsAllowedCallbacks": [
    "string"
  ],
  "subjectNameIdType": "string",
  "subjectNameIdFormat": "string",
  "defaultRelayState": "string",
  "forceAuthentication": true,
  "logoutRedirectUrl": "string",
  "errorRedirectURL": "string"
}'

{
  "id": "string"
}

Was this helpful?

Create SAML Application within a project

See Also

Endpoint Authentication

Try it

Authorization

`Authorization`
Required
Bearer <token>

Request Body

`id`string

`name`string

`description`string

`enabled`boolean

`logo`string

`loginPageUrl`string

`useMetadataInfo`boolean

`metadataUrl`string

`entityId`string

`acsUrl`string

`certificate`string

`attributeMapping`array<object>

`groupsMapping`array<object>

`acsAllowedCallbacks`array<string>

`subjectNameIdType`string

`subjectNameIdFormat`string

`defaultRelayState`string

`forceAuthentication`boolean

`logoutRedirectUrl`string

`errorRedirectURL`string

Create SAML Application within a project

See Also

Endpoint Authentication

Try it

Authorization

AuthorizationRequiredBearer <token>

Request Body

idstring

namestring

descriptionstring

enabledboolean

logostring

loginPageUrlstring

useMetadataInfoboolean

metadataUrlstring

entityIdstring

acsUrlstring

certificatestring

attributeMappingarray<object>

Object 1

groupsMappingarray<object>

Object 1

acsAllowedCallbacksarray<string>

subjectNameIdTypestring

subjectNameIdFormatstring

defaultRelayStatestring

forceAuthenticationboolean

logoutRedirectUrlstring

errorRedirectURLstring

Response

Typescript

`Authorization`
Required
Bearer <token>

`id`string

`name`string

`description`string

`enabled`boolean

`logo`string

`loginPageUrl`string

`useMetadataInfo`boolean

`metadataUrl`string

`entityId`string

`acsUrl`string

`certificate`string

`attributeMapping`array<object>

`groupsMapping`array<object>

`acsAllowedCallbacks`array<string>

`subjectNameIdType`string

`subjectNameIdFormat`string

`defaultRelayState`string

`forceAuthentication`boolean

`logoutRedirectUrl`string

`errorRedirectURL`string