PATCH
/
v1
/
accounts
/
{account_id}
/
users
/
{user_id}
Update User
curl --request PATCH \
  --url https://api.fireworks.ai/v1/accounts/{account_id}/users/{user_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "displayName": "<string>",
  "serviceAccount": true,
  "role": "<string>",
  "email": "<string>"
}'
{
  "name": "<string>",
  "displayName": "<string>",
  "serviceAccount": true,
  "createTime": "2023-11-07T05:31:56Z",
  "role": "<string>",
  "email": "<string>",
  "state": "STATE_UNSPECIFIED",
  "status": {
    "code": "OK",
    "message": "<string>"
  },
  "updateTime": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
account_id
string
required

The Account Id

​
user_id
string
required

The User Id

Body

application/json

The properties of the User being updated. user.name must be populated with the updated resource's name.

​
role
string
required

The user's role, e.g. admin or user.

​
displayName
string

Human-readable display name of the user. e.g. "Alice" Must be fewer than 64 characters long.

​
serviceAccount
boolean
​
email
string

The user's email address.

​
state
enum<string>
default:STATE_UNSPECIFIED

The state of the user.

Available options:
STATE_UNSPECIFIED,
CREATING,
READY,
UPDATING,
DELETING
​
status
object

Contains information about the user status.

Response

200 - application/json

A successful response.

​
role
string
required

The user's role, e.g. admin or user.

​
name
string
​
displayName
string

Human-readable display name of the user. e.g. "Alice" Must be fewer than 64 characters long.

​
serviceAccount
boolean
​
createTime
string<date-time>

The creation time of the user.

​
email
string

The user's email address.

​
state
enum<string>
default:STATE_UNSPECIFIED

The state of the user.

Available options:
STATE_UNSPECIFIED,
CREATING,
READY,
UPDATING,
DELETING
​
status
object

Contains information about the user status.

​
updateTime
string<date-time>

The update time for the user.