Create Saml App

POST/v1/admin/saml-apps

Authorization

HTTPBearer

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*Name

Length1 <= length <= 200

sp_entity_id*Sp Entity Id

Length1 <= length

billing_model?Billing Model

Default"workforce"

Value in

"workforce"
"external"

acs_urls*array<>

Items1 <= items

name_id_format?Name Id Format

Default"urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress"

attribute_map?

attribute_name_format?Attribute Name Format

Default"unspecified"

authn_context_class_ref?Authn Context Class Ref

Default"urn:oasis:names:tc:SAML:2.0:ac:classes:Biometric"

sp_signing_cert_pem?string|null

encryption_cert_pem?string|null

want_assertions_signed?Want Assertions Signed

Defaulttrue

want_response_signed?Want Response Signed

Defaulttrue

allow_idp_initiated?Allow Idp Initiated

Defaultfalse

default_relay_state?|null

branding?|null

allow_signup?Allow Signup

Defaultfalse

signup_group_id?|null

allowed_email_origins?array<string>

terms_url?string|null

privacy_url?string|null

signup_scopes?array<string>

Response Body

`application/json`

curl -X POST "https://example.com/v1/admin/saml-apps" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "sp_entity_id": "string",    "acs_urls": [      {        "url": "string"      }    ]  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "protocol": "saml",  "name": "string",  "sp_entity_id": "string",  "billing_model": "workforce",  "acs_urls": [    {      "url": "string",      "binding": "post"    }  ],  "name_id_format": "string",  "attribute_map": {    "property1": "string",    "property2": "string"  },  "attribute_name_format": "string",  "authn_context_class_ref": "string",  "sp_signing_cert_pem": "string",  "encryption_cert_pem": "string",  "want_assertions_signed": true,  "want_response_signed": true,  "allow_idp_initiated": true,  "default_relay_state": "string",  "branding": {},  "allow_signup": true,  "signup_group_id": "ff47fb4a-8bed-4084-996e-a273d2ed9d1b",  "allowed_email_origins": [    "string"  ],  "terms_url": "string",  "privacy_url": "string",  "signup_scopes": [    "string"  ],  "created_at": "string",  "revoked_at": "string",  "idp": {    "entity_id": "string",    "sso_url": "string",    "metadata_url": "string",    "certificate_url": "string",    "certificate_pem": "string",    "certificate_fingerprint_sha256": "string"  }}

{  "detail": [    {      "loc": [        "string"      ],      "msg": "string",      "type": "string",      "input": null,      "ctx": {}    }  ]}

Authorization

Request Body

Response Body

201application/json

422application/json

`application/json`

`application/json`