Create user

curl --request POST \
  --url https://api.example.com/api/v1/organizations/{organizationID}/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "spec": {
    "subject": "[email protected]",
    "state": "active",
    "groupIDs": [
      "0aaba80d-67ef-4799-b6d9-59f37e2ce2ad"
    ]
  }
}
'

{
  "metadata": {
    "id": "ee45f34b-9685-40d8-8724-23c31252ca46",
    "name": "undefined",
    "organizationId": "d4600d6e-e965-4b44-a808-84fb2fa36702",
    "creationTime": "2024-05-31T14:11:00Z",
    "provisioningStatus": "provisioned",
    "healthStatus": "healthy"
  },
  "spec": {
    "subject": "[email protected]",
    "state": "active",
    "groupIDs": [
      "0aaba80d-67ef-4799-b6d9-59f37e2ce2ad"
    ]
  },
  "status": {
    "lastAcive": "2025-01-12T10:49:13Z"
  }
}

POST

api

organizations

{organizationID}

users

Create user

curl --request POST \
  --url https://api.example.com/api/v1/organizations/{organizationID}/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "spec": {
    "subject": "[email protected]",
    "state": "active",
    "groupIDs": [
      "0aaba80d-67ef-4799-b6d9-59f37e2ce2ad"
    ]
  }
}
'

{
  "metadata": {
    "id": "ee45f34b-9685-40d8-8724-23c31252ca46",
    "name": "undefined",
    "organizationId": "d4600d6e-e965-4b44-a808-84fb2fa36702",
    "creationTime": "2024-05-31T14:11:00Z",
    "provisioningStatus": "provisioned",
    "healthStatus": "healthy"
  },
  "spec": {
    "subject": "[email protected]",
    "state": "active",
    "groupIDs": [
      "0aaba80d-67ef-4799-b6d9-59f37e2ce2ad"
    ]
  },
  "status": {
    "lastAcive": "2025-01-12T10:49:13Z"
  }
}

Authorizations

Authorization

string

header

required

Operation requires OAuth 2.0 bearer token authentication.

Path Parameters

organizationID

string

required

An organization ID.

Body

application/json

Body required to create a user.

A user create/update object.

spec

object

required

A user specification.

Show child attributes

spec.subject

string

required

The user's canonical name, usually an email address.

spec.state

enum<string>

required

The state a user is in.

Available options:

active,

pending,

suspended

spec.groupIDs

string[]

required

A list of group IDs.

A group ID.

metadata

object

Metadata required for all API resource reads and writes.

Show child attributes

metadata.name

string

required

A valid Kubernetes label value, typically used for resource names that can be indexed in the database.

metadata.description

string

The resource description, this optionally augments the name with more context.

metadata.tags

object[]

A list of tags.

Show child attributes

metadata.tags.name

string

required

A unique tag name.

metadata.tags.value

string

required

The value of the tag.

Response

A user.

A user read object.

metadata

object

required

Metadata required by organization scoped resource reads.

Show child attributes

metadata.name

string

required

A valid Kubernetes label value, typically used for resource names that can be indexed in the database.

metadata.id

string

required

The unique resource ID.

metadata.creationTime

string<date-time>

required

The time the resource was created.

metadata.provisioningStatus

enum<string>

required

The provisioning state of a resource.

Available options:

unknown,

provisioning,

provisioned,

deprovisioning,

error

metadata.healthStatus

enum<string>

required

The health state of a resource.

Available options:

unknown,

healthy,

degraded,

error

metadata.organizationId

string

required

The organization identifier the resource belongs to.

metadata.description

string

The resource description, this optionally augments the name with more context.

metadata.tags

object[]

A list of tags.

Show child attributes

metadata.tags.name

string

required

A unique tag name.

metadata.tags.value

string

required

The value of the tag.

metadata.createdBy

string

The user who created the resource.

metadata.modifiedTime

string<date-time>

The time a resource was updated.

metadata.modifiedBy

string

The user who updated the resource.

metadata.deletionTime

string<date-time>

The time the resource was deleted.

spec

object

required

A user specification.

Show child attributes

spec.subject

string

required

The user's canonical name, usually an email address.

spec.state

enum<string>

required

The state a user is in.

Available options:

active,

pending,

suspended

spec.groupIDs

string[]

required

A list of group IDs.

A group ID.

status

object

required

Additional user metadata.

Show child attributes

status.lastActive

string<date-time>

The last time a user performed some action. This is not guaranteed to be completely accurate depending on performance constraints.

List users Update user

⌘I

Serverless Inference

Fine Tuning

Compute

Networking and Storage

Organization

Create user

Authorizations

Path Parameters

Body

Response