Path parameters
-
The unique identifier of the saml application.
Body Required
-
name string
The name of the SAML application.
Minimum length is
1
, maximum length is256
. -
description string | null
Description of the SAML application.
-
customData object
Custom data for the application.
Additional properties are allowed.
-
attributeMapping object
Additional properties are allowed.
-
entityId string | null
Maximum length is
128
. -
acsUrl string | null
The Assertion Consumer Service (ACS) URL.
-
encryption object | null
Validator function
Additional properties are allowed.
-
nameIdFormat string
Values are
urn:oasis:names:tc:SAML:2.0:nameid-format:persistent
,urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress
,urn:oasis:names:tc:SAML:2.0:nameid-format:transient
, orurn:oasis:names:tc:SAML:1.1:nameid-format:unspecified
.
PATCH
/api/saml-applications/{id}
curl \
--request PATCH https://[tenant_id].logto.app/api/saml-applications/{id} \
--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 (200)
{
"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"
}