Create SAML application

POST /api/saml-applications

Create a new SAML application with the given configuration. A default signing certificate with 3 years lifetime will be automatically created.

application/json

Body Required

Responses

POST /api/saml-applications
curl \
 --request POST https://[tenant_id].logto.app/api/saml-applications \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"name":"string","description":"string","customData":{},"attributeMapping":{"sub":"string","name":"string","given_name":"string","family_name":"string","middle_name":"string","nickname":"string","preferred_username":"string","profile":"string","picture":"string","website":"string","email":"string","email_verified":"string","gender":"string","birthdate":"string","zoneinfo":"string","locale":"string","phone_number":"string","phone_number_verified":"string","address":"string","updated_at":"string","username":"string","roles":"string","organizations":"string","organization_data":"string","organization_roles":"string","custom_data":"string","identities":"string","sso_identities":"string","created_at":"string"},"entityId":"string","acsUrl":"string","encryption":{},"nameIdFormat":"urn:oasis:names:tc:SAML:2.0:nameid-format:persistent"}'
Request examples
{
  "name": "string",
  "description": "string",
  "customData": {},
  "attributeMapping": {
    "sub": "string",
    "name": "string",
    "given_name": "string",
    "family_name": "string",
    "middle_name": "string",
    "nickname": "string",
    "preferred_username": "string",
    "profile": "string",
    "picture": "string",
    "website": "string",
    "email": "string",
    "email_verified": "string",
    "gender": "string",
    "birthdate": "string",
    "zoneinfo": "string",
    "locale": "string",
    "phone_number": "string",
    "phone_number_verified": "string",
    "address": "string",
    "updated_at": "string",
    "username": "string",
    "roles": "string",
    "organizations": "string",
    "organization_data": "string",
    "organization_roles": "string",
    "custom_data": "string",
    "identities": "string",
    "sso_identities": "string",
    "created_at": "string"
  },
  "entityId": "string",
  "acsUrl": "string",
  "encryption": {},
  "nameIdFormat": "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent"
}
Response examples (201)
{
  "tenantId": "string",
  "id": "string",
  "name": "string",
  "description": "string",
  "type": "Native",
  "customData": {},
  "isThirdParty": true,
  "createdAt": 42.0,
  "attributeMapping": {
    "sub": "string",
    "name": "string",
    "given_name": "string",
    "family_name": "string",
    "middle_name": "string",
    "nickname": "string",
    "preferred_username": "string",
    "profile": "string",
    "picture": "string",
    "website": "string",
    "email": "string",
    "email_verified": "string",
    "gender": "string",
    "birthdate": "string",
    "zoneinfo": "string",
    "locale": "string",
    "phone_number": "string",
    "phone_number_verified": "string",
    "address": "string",
    "updated_at": "string",
    "username": "string",
    "roles": "string",
    "organizations": "string",
    "organization_data": "string",
    "organization_roles": "string",
    "custom_data": "string",
    "identities": "string",
    "sso_identities": "string",
    "created_at": "string"
  },
  "entityId": "string",
  "acsUrl": {
    "binding": "urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST",
    "url": "string"
  },
  "encryption": {},
  "nameIdFormat": "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent"
}