Sign in
Users (iam/v2)

Update Auth Type of a User

General Availability

Update the auth type of a user

patch/iam/v2/users/{id}/auth

Path parameters

idstring required

The unique identifier for the user.

Request body

api_version'iam.v2/User'

APIVersion defines the schema version of this representation of a resource.

kind'ConfigureUserAuthRequest'

Kind defines the object this REST resource represents.

idstring

ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space").

auth_typestring

The user's authentication method.

Example request

{
  "id": "dlz-f3a90de",
  "metadata": {
    "self": "https://api.confluent.cloud/iam.v2/User/configure-user-auth-requests/cuar-12345",
    "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/configure-user-auth-request=cuar-12345",
    "created_at": "2006-01-02T15:04:05-07:00",
    "updated_at": "2006-01-02T15:04:05-07:00",
    "deleted_at": "2006-01-02T15:04:05-07:00"
  },
  "auth_type": "AUTH_TYPE_SSO"
}

Response

No Content

Changes

No recorded changes to this endpoint across all 1 revision of this API.