Skip to main content
POST
/
core.v1.UserService
/
UpdateUser
cURL
curl -X POST "https://api.joinformal.com/core.v1.UserService/UpdateUser" \
  -H "X-API-KEY: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "example": "value"
  }'
{
  "user": {
    "id": "<string>",
    "dbUsername": "<string>",
    "type": "machine",
    "terminationProtection": true,
    "expireAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "groupIds": [
      "<string>"
    ],
    "fullName": "<string>",
    "human": {
      "firstName": "<string>",
      "lastName": "<string>",
      "email": "jsmith@example.com"
    },
    "machine": {
      "name": "<string>"
    }
  }
}

Authorizations

​
X-API-KEY
string
header
required

API key authentication. Get your API key from the Formal console.

Body

application/json
​
id
string
Minimum string length: 1
​
name
string | null

For machine users: update the machine user name.

Minimum string length: 1
​
firstName
string | null

For human users: update the first name.

Minimum string length: 1
​
lastName
string | null

For human users: update the last name.

Minimum string length: 1
​
terminationProtection
boolean

Response

Success

​
user
user · object

Exactly one of these fields is required: human or machine.