SetIdentityMode
PUT/admin/v1/customers/:customer_id/identity-mode
SetIdentityMode writes the identity mode of the whole install (decision record 105). The mode covers every organization of the install. The request names the organization of the caller, and the caller must hold system_settings.edit on that organization.
The call is a preview for non-production installs. The management plane refuses every call with FAILED_PRECONDITION unless its environment variable DIRECTORY_IDENTITY_PREVIEW is true, and the refusal names the variable. A customer install never sets the variable.
With the variable set, a write of DIRECTORY puts the install in directory identity mode. A write of the mode the install already has changes nothing, and the response then has wrote false. A write of BUILT_IN on a directory-mode install is refused with FAILED_PRECONDITION, unless the management plane also sets DIRECTORY_IDENTITY_REVERSIBLE and the install holds no directory-mode record and no IdP registration. Every write that changes the mode records the audit action SET_IDENTITY_MODE.
Request
Responses
- 200
Success