Skip to main content

Deactivate a user schema

POST 
/resources/v3alpha/user_schemas/:id/_deactivate

Deactivate an existing user schema and change it into a read-only state. Users based on this schema cannot be updated anymore, but are still able to authenticate.

Request​

Path Parameters

    id stringrequired

    unique identifier of the schema.

Query Parameters

    instance.id string
    instance.domain string

Responses​

Schema successfully deactivated

Schema

    details

    object

    Details provide some base information (such as the last change date) of the schema.

    id string
    created date-time

    the timestamp of the first event applied to the object.

    changed date-time

    the timestamp of the last event applied to the object.

    owner

    object

    the parent object representing the returned objects context.

    type string

    Possible values: [OWNER_TYPE_UNSPECIFIED, OWNER_TYPE_SYSTEM, OWNER_TYPE_INSTANCE, OWNER_TYPE_ORG]

    Default value: OWNER_TYPE_UNSPECIFIED

    id string
Loading...