User – Exoscale Documentation

User

IAM users map to humans empowered with access to Exoscale resources.

create-user

Create a User

POST /user

null

Request body

Content-Type: application/json

Property	Type	Required	Description
`email`	string	yes	User Email
`role`	object	no	IAM Role schema details

Example

{
  "email": "string",
  "role": {
    "description": "string",
    "editable": true,
    "id": "string",
    "labels": {},
    "name": "string",
    "permissions": [
      "bypass-governance-retention"
    ],
    "policy": {
      "default-service-strategy": "allow",
      "services": {}
    }
  }
}

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	object	Related resource reference schema details
`state`	string	Operation status Allowed values: `failure`, `pending`, `success`, `timeout`.

Example output

{
  "id": "string",
  "message": "string",
  "reason": "incorrect",
  "reference": {
    "command": "string",
    "id": "string",
    "link": "string"
  },
  "state": "failure"
}

SDK reference for create-user: golang | Python | Java

CLI: exo api create-user

delete-user

Delete User

DELETE /user/{id}

null

Path parameters

Name	In	Description
`id`	`path`

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	object	Related resource reference schema details
`state`	string	Operation status Allowed values: `failure`, `pending`, `success`, `timeout`.

Example output

{
  "id": "string",
  "message": "string",
  "reason": "incorrect",
  "reference": {
    "command": "string",
    "id": "string",
    "link": "string"
  },
  "state": "failure"
}

SDK reference for delete-user: golang | Python | Java

CLI: exo api delete-user

Other Operations

update-user-role

Update a User’s IAM role

PUT /user/{id}

null

Path parameters

Name	In	Description
`id`	`path`

Request body

Content-Type: application/json

Property	Type	Required	Description
`role`	object	no	IAM Role schema details

Example

{
  "role": {
    "description": "string",
    "editable": true,
    "id": "string",
    "labels": {},
    "name": "string",
    "permissions": [
      "bypass-governance-retention"
    ],
    "policy": {
      "default-service-strategy": "allow",
      "services": {}
    }
  }
}

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	object	Related resource reference schema details
`state`	string	Operation status Allowed values: `failure`, `pending`, `success`, `timeout`.

Example output

{
  "id": "string",
  "message": "string",
  "reason": "incorrect",
  "reference": {
    "command": "string",
    "id": "string",
    "link": "string"
  },
  "state": "failure"
}

SDK reference for update-user-role: golang | Python | Java

CLI: exo api update-user-role

list-users

List Users

GET /user

null

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`users`	array[object]	schema details

Example output

{
  "users": [
    {
      "email": "string",
      "id": "string",
      "pending": true,
      "role": {
        "description": "string",
        "editable": true,
        "id": "string",
        "labels": {},
        "name": "string",
        "permissions": [
          "bypass-governance-retention"
        ],
        "policy": {
          "default-service-strategy": "allow",
          "services": {}
        }
      },
      "sso": true,
      "two-factor-authentication": true
    }
  ]
}

SDK reference for list-users: golang | Python | Java

CLI: exo api list-users

Last updated on January 28, 2026