IAM – Exoscale Documentation

IAM

Identity and Access Management: roles, users, policies and credentials for accessing the Exoscale API.

create-api-key

Create a new API key

POST /api-key

null

Request body

application/json
- role-id (required) (string): IAM API Key Role ID
- name (required) (string): IAM API Key Name

Responses

200: 200
- application/json
  - name (string): IAM API Key name
  - key (string): IAM API Key
  - secret (string): IAM API Key Secret
  - role-id (string): IAM API Key Role ID

SDK reference for create-api-key: golang | Python | Java

CLI: exo api create-api-key

get-api-key

Get API key

GET /api-key/{id}

null

Path parameters

id in path (required)

Responses

200: 200
- application/json
  - name (string): IAM API Key name
  - key (string): IAM API Key
  - role-id (string): IAM API Key Role ID

SDK reference for get-api-key: golang | Python | Java

CLI: exo api get-api-key

delete-api-key

Delete an API key

DELETE /api-key/{id}

null

Path parameters

id in path (required)

Responses

200: 200
- application/json
  - id (string): Operation ID
  - reason (string): Operation failure reason
  - reference (object): Related resource reference - schema details
  - message (string): Operation message
  - state (string): Operation status

SDK reference for delete-api-key: golang | Python | Java

CLI: exo api delete-api-key

reset-iam-organization-policy

Reset IAM Organization Policy

POST /iam-organization-policy:reset

Responses

200: 200
- application/json
  - id (string): Operation ID
  - reason (string): Operation failure reason
  - reference (object): Related resource reference - schema details
  - message (string): Operation message
  - state (string): Operation status

SDK reference for reset-iam-organization-policy: golang | Python | Java

CLI: exo api reset-iam-organization-policy

get-iam-organization-policy

Retrieve IAM Organization Policy

GET /iam-organization-policy

Responses

200: 200
- application/json
  - default-service-strategy (string): IAM default service strategy
  - services (object): IAM services

SDK reference for get-iam-organization-policy: golang | Python | Java

CLI: exo api get-iam-organization-policy

update-iam-organization-policy

Update IAM Organization Policy

PUT /iam-organization-policy

Request body

application/json
- default-service-strategy (required) (string): IAM default service strategy
- services (required) (object): IAM services

Responses

200: 200
- application/json
  - id (string): Operation ID
  - reason (string): Operation failure reason
  - reference (object): Related resource reference - schema details
  - message (string): Operation message
  - state (string): Operation status

SDK reference for update-iam-organization-policy: golang | Python | Java

CLI: exo api update-iam-organization-policy

create-iam-role

Create IAM Role

POST /iam-role

Request body

application/json
- name (required) (string): IAM Role name
- description (string): IAM Role description
- permissions (array[string]): IAM Role permissions
- editable (boolean): Sets if the IAM Role Policy is editable or not (default: true). This setting cannot be changed after creation
- labels (object)
- policy (object): Policy - schema details

Responses

200: 200
- application/json
  - id (string): Operation ID
  - reason (string): Operation failure reason
  - reference (object): Related resource reference - schema details
  - message (string): Operation message
  - state (string): Operation status

SDK reference for create-iam-role: golang | Python | Java

CLI: exo api create-iam-role

get-iam-role

Retrieve IAM Role

GET /iam-role/{id}

Path parameters

id in path (required)

Responses

200: 200
- application/json
  - id (string): IAM Role ID
  - name (string): IAM Role name
  - description (string): IAM Role description
  - permissions (array[string]): IAM Role permissions
  - labels (object)
  - editable (boolean): IAM Role mutability
  - policy (object): Policy - schema details

SDK reference for get-iam-role: golang | Python | Java

CLI: exo api get-iam-role

update-iam-role

Update IAM Role

PUT /iam-role/{id}

Path parameters

id in path (required)

Request body

application/json
- description (string): IAM Role description
- permissions (array[string]): IAM Role permissions
- labels (object)

Responses

200: 200
- application/json
  - id (string): Operation ID
  - reason (string): Operation failure reason
  - reference (object): Related resource reference - schema details
  - message (string): Operation message
  - state (string): Operation status

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

CLI: exo api update-iam-role

delete-iam-role

Delete IAM Role

DELETE /iam-role/{id}

Path parameters

id in path (required)

Responses

200: 200
- application/json
  - id (string): Operation ID
  - reason (string): Operation failure reason
  - reference (object): Related resource reference - schema details
  - message (string): Operation message
  - state (string): Operation status

SDK reference for delete-iam-role: golang | Python | Java

CLI: exo api delete-iam-role

create-user

Create a User

POST /user

null

Request body

application/json
- email (required) (string): User Email
- role (object): IAM Role - schema details

Responses

200: 200
- application/json
  - id (string): Operation ID
  - reason (string): Operation failure reason
  - reference (object): Related resource reference - schema details
  - message (string): Operation message
  - state (string): Operation status

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

CLI: exo api create-user

delete-user

Delete User

DELETE /user/{id}

null

Path parameters

id in path (required)

Responses

200: 200
- application/json
  - id (string): Operation ID
  - reason (string): Operation failure reason
  - reference (object): Related resource reference - schema details
  - message (string): Operation message
  - state (string): Operation status

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

CLI: exo api delete-user

Other Operations

list-api-keys

List API keys

GET /api-key

null

Responses

200: 200
- application/json
  - api-keys (array[object]) - schema details

SDK reference for list-api-keys: golang | Python | Java

CLI: exo api list-api-keys

update-iam-role-policy

Update IAM Role Policy

PUT /iam-role/{id}:policy

Path parameters

id in path (required)

Request body

application/json
- default-service-strategy (required) (string): IAM default service strategy
- services (required) (object): IAM services

Responses

200: 200
- application/json
  - id (string): Operation ID
  - reason (string): Operation failure reason
  - reference (object): Related resource reference - schema details
  - message (string): Operation message
  - state (string): Operation status

SDK reference for update-iam-role-policy: golang | Python | Java

CLI: exo api update-iam-role-policy

list-iam-roles

List IAM Roles

GET /iam-role

Responses

200: 200
- application/json
  - iam-roles (array[object]) - schema details

SDK reference for list-iam-roles: golang | Python | Java

CLI: exo api list-iam-roles

update-user-role

Update a User’s IAM role

PUT /user/{id}

null

Path parameters

id in path (required)

Request body

application/json
- role (object): IAM Role - schema details

Responses

200: 200
- application/json
  - id (string): Operation ID
  - reason (string): Operation failure reason
  - reference (object): Related resource reference - schema details
  - message (string): Operation message
  - state (string): Operation status

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

CLI: exo api update-user-role

list-users

List Users

GET /user

null

Responses

200: 200
- application/json
  - users (array[object]) - schema details

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

CLI: exo api list-users

Last updated on January 9, 2026