Skip to content

Update an instance service account

PATCH
/api/v4/service_accounts/{user_id}

Updates a specified instance service account.

user_id
required
integer

The ID of the service account user

Media type application/json
object
name

Name of the user

string
nullable
username

Username of the user

string
nullable
email

Custom email address for the user

string
nullable
Example generated
{
"name": "example",
"username": "example",
"email": "example"
}

OK

Media type application/json
object
id
integer format: int64
username
string
public_email
string
name
string
email
string
unconfirmed_email
string
Example
{
"id": 1,
"username": "admin",
"public_email": "john@example.com",
"name": "Administrator",
"email": "service_account@example.com",
"unconfirmed_email": "updated_service_account@example.com"
}

400 Bad request

401 Unauthorized

403 Forbidden

404 Not found