Sign in
Users (iam/v2)

Read a User

General Availability

Make a request to read a user.

get/iam/v2/users/{id}

Path parameters

idstring required

The unique identifier for the user.

Response

User.

api_version'iam/v2' required

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

kind'User' required

Kind defines the object this REST resource represents.

idstring required

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").

emailstring email required

The user's email address

full_namestring

The user's full name

auth_typestring

The user's authentication method

Example response

{
  "id": "dlz-f3a90de",
  "metadata": {
    "self": "https://api.confluent.cloud/iam/v2/users/u-12345",
    "resource_name": "crn://confluent.cloud/user=u-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"
  },
  "email": "marty.mcfly@example.com",
  "full_name": "Marty McFly",
  "auth_type": "AUTH_TYPE_SSO"
}

Changes

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