Returns the specified User

GET 
/v1/users/:uid

Returns a User for the specified uid.

Request

Path Parameters

uid stringrequired

Responses

200

OK

application/json

Schema

Schema

metadata

object

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

annotations

object

Annotations are system generated key value metadata for the resource. As an input certain annotations like description can be set.

property name*string

creationTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

deletionTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

labels

object

Labels are key value data to organize and categorize resources. Providing spectro__tag as value for a label is considered as a kubernetes compliant tag

property name*string

lastModifiedTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

namestring

Name of the resource.

uidstring

UID is the unique identifier generated for the resource. This is not an input field for any request.

spec

User specifications

emailIdstring

User's email id

firstNamestring

lastNamestring

rolesstring[]

status

User status

activationLinkstring

provides the link to activate or reset the user password

isActiveboolean

Specifies if user account is active/disabled

isPasswordResettingboolean

Specifies if user in multi org requested password reset

lastSignIndate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

Example (from schema)

{
  "metadata": {
    "annotations": {},
    "creationTimestamp": "2024-04-28T17:06:41.382Z",
    "deletionTimestamp": "2024-04-28T17:06:41.382Z",
    "labels": {},
    "lastModifiedTimestamp": "2024-04-28T17:06:41.382Z",
    "name": "string",
    "uid": "string"
  },
  "spec": {
    "emailId": "string",
    "firstName": "string",
    "lastName": "string",
    "roles": [
      "string"
    ]
  },
  "status": {
    "activationLink": "string",
    "isActive": true,
    "isPasswordResetting": true,
    "lastSignIn": "2024-04-28T17:06:41.382Z"
  }
}

Loading...