DEAP API · Identity provider
PreviewIdentity provider: enable
/api/core/identity/identity-providers/enableHeaders
AuthorizationstringRequiredAccess token of a signed-in user. It carries the tenant, the user and their roles.
Idempotency-KeystringOptionalA key you choose that is unique to this attempt, so a retry is not applied twice.
X-Company-IDstringOptionalCompany the command acts on. Refused with 403 if the caller has no access to it.
Content-TypestringRequiredAlways
application/json.
Request body
The fields of the ENABLE command. The body is the command itself; it is not wrapped in another object.
Response
Status 200. The command ran. The body is its outcome.
footprintstringRequiredFingerprint of what was committed.
statusstringRequiredSUCCESSwhen the command was committed.tx_idstringRequiredIdentifier of the committed transaction.
committed_atdate-timeOptionalWhen the command was committed.
dataanyOptionalWhat the command returned: the record, a list, or nothing.
errorobjectOptionalWhy a command was not committed.
4 child fields
codestringRequiredNo description yet.
messagestringRequiredNo description yet.
detailsanyOptionalFurther detail, when there is any.
fieldstringOptionalThe field the error is about, when there is one.
financial_impactobjectOptionalLedger effect of the command, when it has one.
semantic_contextobjectOptionalBusiness context recorded with the command.
Errors
Every error carries an HTTP status. Where it also carries a code, branch on the code, not on the message.
- 400The body is not one JSON value.
- 401The access token is missing, expired or not valid.
- 403The caller has no access to the company named in
X-Company-ID. - 422The command was refused: a field is invalid, or the record is not in a state that allows the action. The message says which.