ByCloud Docs
GuidesCLIAPISDK

Python SDK

IAM

Users, service accounts, groups, roles, policies, and authorization

52 methods

POST

assume_role()

Assume role

Parameters

role_id

string

required
duration_seconds

integer

- Credential validity duration (15 min to 12 hours)

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.assume_role(role_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
GET

list_groups()

List groups

Parameters

limit

integer

- Maximum number of items to return

marker

string

- ID of the last item from the previous page (for pagination)

name

string

- Filter by name (exact match or prefix with *)

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.list_groups()
print(result)
POST

create_group()

Create group

Parameters

name

string

required
description

string

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.create_group(name="developers")
print(result)
GET

get_group()

Get group

Parameters

group_id

string

required

- Group ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.get_group(group_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
PATCH

update_group()

Update group

Parameters

group_id

string

required

- Group ID

name

string

description

string

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.update_group(group_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
DELETE

delete_group()

Delete group

Parameters

group_id

string

required

- Group ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.delete_group(group_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
GET

list_group_policies()

List group policies

Parameters

group_id

string

required

- Group ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.list_group_policies(group_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
POST

attach_group_policy()

Attach policy to group

Parameters

group_id

string

required

- Group ID

policy_id

string

required

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.attach_group_policy(group_id="550e8400-e29b-41d4-a716-446655440000", policy_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
DELETE

detach_group_policy()

Detach policy from group

Parameters

group_id

string

required

- Group ID

policy_id

string

required

- Policy ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.detach_group_policy(group_id="550e8400-e29b-41d4-a716-446655440000", policy_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
GET

list_group_service_accounts()

List group service accounts

Parameters

group_id

string

required

- Group ID

limit

integer

- Maximum number of items to return

marker

string

- ID of the last item from the previous page (for pagination)

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.list_group_service_accounts(group_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
GET

list_group_users()

List group users

Parameters

group_id

string

required

- Group ID

limit

integer

- Maximum number of items to return

marker

string

- ID of the last item from the previous page (for pagination)

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.list_group_users(group_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
GET

list_policies()

List policies

Parameters

limit

integer

- Maximum number of items to return

marker

string

- ID of the last item from the previous page (for pagination)

name

string

- Filter by name (exact match or prefix with *)

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.list_policies()
print(result)
POST

create_policy()

Create policy

Parameters

name

string

required
description

string

document

object

required

- IAM-style policy document

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.create_policy(name="S3BucketAccess", document=[object Object])
print(result)
GET

get_policy()

Get policy

Parameters

policy_id

string

required

- Policy ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.get_policy(policy_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
PATCH

update_policy()

Update policy

Parameters

policy_id

string

required

- Policy ID

name

string

description

string

document

object

- IAM-style policy document

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.update_policy(policy_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
DELETE

delete_policy()

Delete policy

Parameters

policy_id

string

required

- Policy ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.delete_policy(policy_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
GET

list_policy_groups()

List groups with policy

Parameters

policy_id

string

required

- Policy ID

limit

integer

- Maximum number of items to return

marker

string

- ID of the last item from the previous page (for pagination)

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.list_policy_groups(policy_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
GET

list_policy_roles()

List roles with policy

Parameters

policy_id

string

required

- Policy ID

limit

integer

- Maximum number of items to return

marker

string

- ID of the last item from the previous page (for pagination)

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.list_policy_roles(policy_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
GET

list_policy_service_accounts()

List service accounts with policy

Parameters

policy_id

string

required

- Policy ID

limit

integer

- Maximum number of items to return

marker

string

- ID of the last item from the previous page (for pagination)

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.list_policy_service_accounts(policy_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
GET

list_policy_users()

List users with policy

Parameters

policy_id

string

required

- Policy ID

limit

integer

- Maximum number of items to return

marker

string

- ID of the last item from the previous page (for pagination)

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.list_policy_users(policy_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
GET

list_roles()

List roles

Parameters

limit

integer

- Maximum number of items to return

marker

string

- ID of the last item from the previous page (for pagination)

name

string

- Filter by name (exact match or prefix with *)

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.list_roles()
print(result)
POST

create_role()

Create role

Parameters

name

string

required
description

string

trust_policy

object

- Defines who/what can assume this role using CRN patterns

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.create_role(name="S3ReadOnly")
print(result)
GET

get_role()

Get role

Parameters

role_id

string

required

- Role ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.get_role(role_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
PATCH

update_role()

Update role

Parameters

role_id

string

required

- Role ID

name

string

description

string

trust_policy

object

- Defines who/what can assume this role using CRN patterns

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.update_role(role_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
DELETE

delete_role()

Delete role

Parameters

role_id

string

required

- Role ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.delete_role(role_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
GET

list_role_policies()

List role policies

Parameters

role_id

string

required

- Role ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.list_role_policies(role_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
POST

attach_role_policy()

Attach policy to role

Parameters

role_id

string

required

- Role ID

policy_id

string

required

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.attach_role_policy(role_id="550e8400-e29b-41d4-a716-446655440000", policy_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
DELETE

detach_role_policy()

Detach policy from role

Parameters

role_id

string

required

- Role ID

policy_id

string

required

- Policy ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.detach_role_policy(role_id="550e8400-e29b-41d4-a716-446655440000", policy_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
GET

list_service_accounts()

List service accounts

Parameters

limit

integer

- Maximum number of items to return

marker

string

- ID of the last item from the previous page (for pagination)

name

string

- Filter by name (exact match or prefix with *)

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.list_service_accounts()
print(result)
POST

create_service_account()

Create service account

Parameters

name

string

required
display_name

string

description

string

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.create_service_account(name="ci-cd-pipeline")
print(result)
GET

get_service_account()

Get service account

Parameters

service_account_id

string

required

- Service Account ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.get_service_account(service_account_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
PATCH

update_service_account()

Update service account

Parameters

service_account_id

string

required

- Service Account ID

display_name

string

description

string

enabled

boolean

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.update_service_account(service_account_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
DELETE

delete_service_account()

Delete service account

Parameters

service_account_id

string

required

- Service Account ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.delete_service_account(service_account_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
GET

list_service_account_credentials()

List credentials

Parameters

service_account_id

string

required

- Service Account ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.list_service_account_credentials(service_account_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
POST

create_service_account_credential()

Create credential

Parameters

service_account_id

string

required

- Service Account ID

name

string

required
expires_at

string

- Optional expiration date

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.create_service_account_credential(service_account_id="550e8400-e29b-41d4-a716-446655440000", name="production-key")
print(result)
DELETE

delete_service_account_credential()

Delete credential

Parameters

service_account_id

string

required

- Service Account ID

credential_id

string

required

- Credential ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.delete_service_account_credential(service_account_id="550e8400-e29b-41d4-a716-446655440000", credential_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
GET

list_service_account_groups()

List service account groups

Parameters

service_account_id

string

required

- Service Account ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.list_service_account_groups(service_account_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
POST

add_service_account_to_group()

Add service account to group

Parameters

service_account_id

string

required

- Service Account ID

group_id

string

required

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.add_service_account_to_group(service_account_id="550e8400-e29b-41d4-a716-446655440000", group_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
DELETE

remove_service_account_from_group()

Remove service account from group

Parameters

service_account_id

string

required

- Service Account ID

group_id

string

required

- Group ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.remove_service_account_from_group(service_account_id="550e8400-e29b-41d4-a716-446655440000", group_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
GET

list_service_account_policies()

List service account policies

Parameters

service_account_id

string

required

- Service Account ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.list_service_account_policies(service_account_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
POST

attach_service_account_policy()

Attach policy to service account

Parameters

service_account_id

string

required

- Service Account ID

policy_id

string

required

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.attach_service_account_policy(service_account_id="550e8400-e29b-41d4-a716-446655440000", policy_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
DELETE

detach_service_account_policy()

Detach policy from service account

Parameters

service_account_id

string

required

- Service Account ID

policy_id

string

required

- Policy ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.detach_service_account_policy(service_account_id="550e8400-e29b-41d4-a716-446655440000", policy_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
GET

list_users()

List users

Parameters

limit

integer

- Maximum number of items to return

marker

string

- ID of the last item from the previous page (for pagination)

name

string

- Filter by name (exact match or prefix with *)

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.list_users()
print(result)
POST

add_user()

Add user to organization

Parameters

email

string

required

- Email of the platform user to add

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.add_user(email="john.doe@acme.com")
print(result)
GET

get_user()

Get user

Parameters

user_id

string

required

- User ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.get_user(user_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
DELETE

remove_user()

Remove user from organization

Parameters

user_id

string

required

- User ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.remove_user(user_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
GET

list_user_groups()

List user groups

Parameters

user_id

string

required

- User ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.list_user_groups(user_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
POST

add_user_to_group()

Add user to group

Parameters

user_id

string

required

- User ID

group_id

string

required

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.add_user_to_group(user_id="550e8400-e29b-41d4-a716-446655440000", group_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
DELETE

remove_user_from_group()

Remove user from group

Parameters

user_id

string

required

- User ID

group_id

string

required

- Group ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.remove_user_from_group(user_id="550e8400-e29b-41d4-a716-446655440000", group_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
GET

list_user_policies()

List user policies

Parameters

user_id

string

required

- User ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.list_user_policies(user_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
POST

attach_user_policy()

Attach policy to user

Parameters

user_id

string

required

- User ID

policy_id

string

required

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.attach_user_policy(user_id="550e8400-e29b-41d4-a716-446655440000", policy_id="550e8400-e29b-41d4-a716-446655440000")
print(result)
DELETE

detach_user_policy()

Detach policy from user

Parameters

user_id

string

required

- User ID

policy_id

string

required

- Policy ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.iam.detach_user_policy(user_id="550e8400-e29b-41d4-a716-446655440000", policy_id="550e8400-e29b-41d4-a716-446655440000")
print(result)