Files
zitadel/apps/docs/content/apis/actions/customize-samlresponse.mdx
T

36 lines
1.2 KiB
Plaintext

---
title: Complement SAMLResponse
description: "Customize and enrich SAML responses via ZITADEL Actions before they are returned to the service provider."
---
This flow is executed before the return of the SAML Response.
The flow is represented by the following Ids in the API: `4`
## Pre SAMLResponse creation
This trigger is called before attributes are set in the SAMLResponse.
The trigger is represented by the following Ids in the API: `6`.
### Parameters of Pre SAMLResponse creation
- `ctx`
The first parameter contains the following fields:
- `v1`
- `getUser()` [*User*](./objects#user)
- `user`
- `getMetadata()` [*metadataResult*](./objects#metadata-result)
- `grants` [*UserGrantList*](./objects#user-grant-list)
- `org`
- `getMetadata()` [*metadataResult*](./objects#metadata-result)
- `api`
The second parameter contains the following fields:
- `v1`
- `attributes`
- `setCustomAttribute(string, string, ...string)`
Sets any value as attribute in addition to the default attributes, if the key is not already present. The parameters represent the key, nameFormat and the attributeValue(s).
- `user`
- `setMetadata(string, Any)`
Key of the metadata and any value