WorkOS · Schema
UserConsentOption
AuthenticationIdentity ProviderSSOSAMLOIDCSCIMDirectory SyncAuthorizationFGAAudit LogsMFAB2B SaaSAgentsMCP
Properties
| Name | Type | Description |
|---|---|---|
| claim | string | The claim name for this consent option. |
| type | string | The type of consent option. |
| label | string | A human-readable label for this consent option. |
| choices | array | The available choices for this consent option. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/UserConsentOption",
"title": "UserConsentOption",
"type": "object",
"properties": {
"claim": {
"type": "string",
"description": "The claim name for this consent option.",
"example": "tos_accepted"
},
"type": {
"type": "string",
"description": "The type of consent option.",
"const": "enum"
},
"label": {
"type": "string",
"description": "A human-readable label for this consent option.",
"example": "Terms of Service"
},
"choices": {
"type": "array",
"description": "The available choices for this consent option.",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The value of this choice.",
"example": "accepted"
},
"label": {
"type": "string",
"description": "A human-readable label for this choice.",
"example": "I accept the Terms of Service"
}
}
},
"example": [
{
"value": "accepted",
"label": "I accept the Terms of Service"
}
]
}
},
"required": [
"claim",
"type",
"label",
"choices"
]
}