IAM - Uncloud

Manage users, roles, and groups for access control.

Users

List Users

GET /api/v1/iam/users

[
  {
    "id": "usr_a1b2c3d4",
    "username": "alice",
    "email": "alice@example.com",
    "roles": ["developer"],
    "groups": ["engineering"],
    "created_at": "2024-01-15T10:30:00Z"
  }
]

Create a User

POST /api/v1/iam/users

string

required

Unique username

string

required

Email address

string[]

Roles to assign

string[]

Groups to add to

Delete a User

DELETE /api/v1/iam/users/{id}

Roles

List Roles

GET /api/v1/iam/roles

[
  {
    "id": "role_admin",
    "name": "Admin",
    "permissions": ["*"],
    "created_at": "2024-01-15T10:30:00Z"
  },
  {
    "id": "role_developer",
    "name": "Developer",
    "permissions": ["apps:*", "databases:read", "storage:read"],
    "created_at": "2024-01-15T10:30:00Z"
  }
]

Create a Role

POST /api/v1/iam/roles

string

required

Role name

string[]

required

List of permission strings

{
  "name": "read-only",
  "permissions": [
    "compute:read",
    "apps:read",
    "databases:read",
    "storage:read"
  ]
}

Delete a Role

DELETE /api/v1/iam/roles/{id}

Groups

List Groups

GET /api/v1/iam/groups

Create a Group

POST /api/v1/iam/groups

string

required

Group name

string[]

Roles inherited by all members

Delete a Group

DELETE /api/v1/iam/groups/{id}

Permission Format

Permissions follow the pattern resource:action:

Permission	Description
`compute:read`	View Droplets
`compute:write`	Create/modify/delete Droplets
`compute:*`	Full Droplet access
`apps:read`	View Apps
`apps:write`	Deploy/modify/delete Apps
`databases:*`	Full database access
`storage:*`	Full storage access
`admin:*`	Administrative access
`*`	Full access (superadmin)

​Users

​List Users

​Create a User

​Delete a User

​Roles

​List Roles

​Create a Role

​Delete a Role

​Groups

​List Groups

​Create a Group

​Delete a Group

​Permission Format

Users

List Users

Create a User

Delete a User

Roles

List Roles

Create a Role

Delete a Role

Groups

List Groups

Create a Group

Delete a Group

Permission Format