Skip to content

tebib iam

Generated from the CLI's own command tree. Run tebib iam --help for the same text in your terminal.

Identity and access management: who may do what in an organization.

Commands

tebib iam credential-report

Every user, service account and role with its last activity, and every access key.

tebib iam credential-report [OPTIONS]
OptionValueDescription
--orgstrOrganization ID (default: from the profile).
--output, -otable | json | yamlOutput format.

Examples

tebib iam credential-report # every principal's last activity and keys

tebib iam simulate

Would a principal be allowed? Checks every action on every resource with the same rules as real requests and names the policy statements that decide.

tebib iam simulate [OPTIONS]
OptionValueDescription
--principal, -p requiredstrTRN, or user/<id>, service-account/<id>, role/<id>, role-session/<id>.
--action, -a requiredstr (repeatable)Action to check, e.g. compute:StartVM (repeatable).
--resource, -r requiredstr (repeatable)Resource TRN; '<type>/*' checks a create (repeatable).
--context, -cKEY=VALUE (repeatable)Request key to simulate, KEY=VALUE (repeatable): auth:mfa=true, auth:source-ip=..., auth:current-time=..., auth:credential-type=access-key, resource:tag/<key>=..., request:tag/<key>=...
--session-policyFILERoles only: a session policy JSON file (or -), as if passed to role assume.
--fail-on-denyflagExit 4 if any pair is denied (for CI checks).
--orgstrOrganization ID (default: from the profile).
--output, -otable | json | yamlOutput format.

Examples

tebib iam simulate -p user/u-... -a compute:StartVM -a compute:DeleteVM -r trn:tebib:compute:lab-neo-1:p-...:vm/vm-... -c auth:mfa=true # allowed? by which statement?

tebib iam attachment

Which policies are attached to which principals, and where.

tebib iam attachment attach

Attach a policy to a user, group, service account or role.

tebib iam attachment attach [OPTIONS]
OptionValueDescription
--policy requiredstrPolicy ID, name or TRN.
--principal requiredstrTRN, or user/<id>, group/<id>, ...
--project, -pstrLimit the policy to this project (default: the whole organization).
--orgstrOrganization ID (default: from the profile).
--output, -otable | json | yamlOutput format.

Examples

tebib iam attachment attach --policy ProjectAdmin --principal group/g-... --project p-...

tebib iam attachment detach

Detach a policy (its permissions go at once).

tebib iam attachment detach [OPTIONS] ATTACHMENT_ID
ArgumentDescription
ATTACHMENT_ID requiredAttachment ID.
OptionValueDescription
--orgstrOrganization ID (default: from the profile).
--yes, -yflagDon't ask for confirmation.

tebib iam attachment list

List policy attachments.

tebib iam attachment list [OPTIONS]
OptionValueDescription
--principalstrOnly this principal (TRN or <kind>/<id>).
--policystrOnly this policy (ID, name or TRN).
--orgstrOrganization ID (default: from the profile).
--limitint rangeShow at most this many items.
--output, -otable | json | yamlOutput format.

tebib iam boundary

Permission boundaries: one policy per user, service account or role that caps its identity policies (it grants nothing by itself).

tebib iam boundary list

List permission boundaries.

tebib iam boundary list [OPTIONS]
OptionValueDescription
--principalstrOnly this principal (TRN or <kind>/<id>).
--orgstrOrganization ID (default: from the profile).
--limitint rangeShow at most this many items.
--output, -otable | json | yamlOutput format.

Examples

tebib iam boundary list | remove --principal role/r-...

tebib iam boundary remove

Remove a principal's permission boundary (its policies apply in full again).

tebib iam boundary remove [OPTIONS]
OptionValueDescription
--principal requiredstrTRN, or user/<id>, service-account/<id>, role/<id>.
--orgstrOrganization ID (default: from the profile).
--yes, -yflagDon't ask for confirmation.

Examples

tebib iam boundary list | remove --principal role/r-...

tebib iam boundary set

Set or replace a principal's permission boundary.

tebib iam boundary set [OPTIONS]
OptionValueDescription
--principal requiredstrTRN, or user/<id>, service-account/<id>, role/<id>.
--policy requiredstrPolicy ID, name or TRN.
--orgstrOrganization ID (default: from the profile).
--output, -otable | json | yamlOutput format.

Examples

tebib iam boundary set --principal service-account/sa-... --policy ReadOnly

tebib iam group

Groups of users; policies attached to a group apply to its members.

tebib iam group add-member

Add a member to a group.

tebib iam group add-member [OPTIONS] GROUP_ID USER_ID
ArgumentDescription
GROUP_ID requiredGroup ID (g-...).
USER_ID requiredUser ID (u-...).
OptionValueDescription
--orgstrOrganization ID (default: from the profile).

Examples

tebib iam group add-member g-... u-...

tebib iam group create

Create a group.

tebib iam group create [OPTIONS] NAME
ArgumentDescription
NAME requiredGroup name (letters, digits, +=,.@_-).
OptionValueDescription
--descriptionstrDescription.
--orgstrOrganization ID (default: from the profile).
--output, -otable | json | yamlOutput format.

Examples

tebib iam group create devs

tebib iam group delete

Delete a group (members lose the permissions it gave them).

tebib iam group delete [OPTIONS] GROUP_ID
ArgumentDescription
GROUP_ID requiredGroup ID (g-...).
OptionValueDescription
--orgstrOrganization ID (default: from the profile).
--yes, -yflagDon't ask for confirmation.

tebib iam group list

List groups.

tebib iam group list [OPTIONS]
OptionValueDescription
--orgstrOrganization ID (default: from the profile).
--limitint rangeShow at most this many items.
--output, -otable | json | yamlOutput format.

tebib iam group members

List a group's members.

tebib iam group members [OPTIONS] GROUP_ID
ArgumentDescription
GROUP_ID requiredGroup ID (g-...).
OptionValueDescription
--orgstrOrganization ID (default: from the profile).
--output, -otable | json | yamlOutput format.

tebib iam group remove-member

Remove a member from a group.

tebib iam group remove-member [OPTIONS] GROUP_ID USER_ID
ArgumentDescription
GROUP_ID requiredGroup ID (g-...).
USER_ID requiredUser ID (u-...).
OptionValueDescription
--orgstrOrganization ID (default: from the profile).
--yes, -yflagDon't ask for confirmation.

tebib iam group show

Show a group.

tebib iam group show [OPTIONS] GROUP_ID
ArgumentDescription
GROUP_ID requiredGroup ID (g-...).
OptionValueDescription
--orgstrOrganization ID (default: from the profile).
--output, -otable | json | yamlOutput format.

tebib iam group update

Change a group's description.

tebib iam group update [OPTIONS] GROUP_ID
ArgumentDescription
GROUP_ID requiredGroup ID (g-...).
OptionValueDescription
--description requiredstrNew description.
--orgstrOrganization ID (default: from the profile).
--output, -otable | json | yamlOutput format.

tebib iam guardrail

Organization guardrails: policies that cap every principal, OrgOwners included. With none attached there is no limit; with several, each must allow a request. They never grant anything, and never limit iam:*Guardrail* actions.

tebib iam guardrail attach

Attach a policy as a guardrail. It caps EVERY principal in the organization, owners included, at once: check it first with tebib iam simulate.

tebib iam guardrail attach [OPTIONS] POLICY
ArgumentDescription
POLICY requiredPolicy ID, name or TRN.
OptionValueDescription
--orgstrOrganization ID (default: from the profile).
--output, -otable | json | yamlOutput format.

Examples

tebib iam guardrail attach no-deletes # caps EVERYONE, owners included

tebib iam guardrail detach

Detach a guardrail (its limits go at once). Guardrails never block this.

tebib iam guardrail detach [OPTIONS] GUARDRAIL_ID
ArgumentDescription
GUARDRAIL_ID requiredGuardrail ID (grd-...).
OptionValueDescription
--orgstrOrganization ID (default: from the profile).
--yes, -yflagDon't ask for confirmation.

Examples

tebib iam guardrail list | show grd-... | detach grd-... # detach is never blocked by guardrails

tebib iam guardrail list

List the organization's guardrails.

tebib iam guardrail list [OPTIONS]
OptionValueDescription
--orgstrOrganization ID (default: from the profile).
--limitint rangeShow at most this many items.
--output, -otable | json | yamlOutput format.

Examples

tebib iam guardrail list | show grd-... | detach grd-... # detach is never blocked by guardrails

tebib iam guardrail show

Show a guardrail.

tebib iam guardrail show [OPTIONS] GUARDRAIL_ID
ArgumentDescription
GUARDRAIL_ID requiredGuardrail ID (grd-...).
OptionValueDescription
--orgstrOrganization ID (default: from the profile).
--output, -otable | json | yamlOutput format.

Examples

tebib iam guardrail list | show grd-... | detach grd-... # detach is never blocked by guardrails

tebib iam policy

JSON permission policies and their versions.

tebib iam policy create

Create a customer policy from a JSON document.

tebib iam policy create [OPTIONS] NAME
ArgumentDescription
NAME requiredPolicy name (letters, digits, +=,.@_-).
OptionValueDescription
--document, -f requiredFILEPolicy JSON file, or - for stdin.
--descriptionstrDescription.
--orgstrOrganization ID (default: from the profile).
--output, -otable | json | yamlOutput format.

Examples

tebib iam policy create readers --document policy.json # or -f - (stdin)

tebib iam policy delete

Delete a customer policy (detach it everywhere first).

tebib iam policy delete [OPTIONS] POLICY
ArgumentDescription
POLICY requiredPolicy ID (pol-...) or name.
OptionValueDescription
--orgstrOrganization ID (default: from the profile).
--yes, -yflagDon't ask for confirmation.

tebib iam policy list

List policies.

tebib iam policy list [OPTIONS]
OptionValueDescription
--scopestrall, local (yours) or managed (TebibHost's). Default: all.
--orgstrOrganization ID (default: from the profile).
--limitint rangeShow at most this many items.
--output, -otable | json | yamlOutput format.

Examples

tebib iam policy list --scope managed

tebib iam policy set-default

Make a version the one in force.

tebib iam policy set-default [OPTIONS] POLICY VERSION
ArgumentDescription
POLICY requiredPolicy ID (pol-...) or name.
VERSION requiredVersion number.
OptionValueDescription
--orgstrOrganization ID (default: from the profile).
--output, -otable | json | yamlOutput format.

tebib iam policy show

Show a policy (the table omits the document; use --document or -o json).

tebib iam policy show [OPTIONS] POLICY
ArgumentDescription
POLICY requiredPolicy ID (pol-...) or name.
OptionValueDescription
--documentflagPrint only the default version's document.
--orgstrOrganization ID (default: from the profile).
--output, -otable | json | yamlOutput format.

Examples

tebib iam policy show readers --document

tebib iam policy update

Change a policy's description (the document changes through new versions).

tebib iam policy update [OPTIONS] POLICY
ArgumentDescription
POLICY requiredPolicy ID (pol-...) or name.
OptionValueDescription
--description requiredstrNew description.
--orgstrOrganization ID (default: from the profile).
--output, -otable | json | yamlOutput format.

tebib iam policy version create

Save a new version of a policy's document.

tebib iam policy version create [OPTIONS] POLICY
ArgumentDescription
POLICY requiredPolicy ID (pol-...) or name.
OptionValueDescription
--document, -f requiredFILEPolicy JSON file, or - for stdin.
--set-default, --no-set-defaultflagMake it the version in force.
--orgstrOrganization ID (default: from the profile).
--output, -otable | json | yamlOutput format.

Examples

tebib iam policy version create readers -f policy.json # new default version

tebib iam policy version delete

Delete a version that isn't the default (its number is never reused).

tebib iam policy version delete [OPTIONS] POLICY VERSION
ArgumentDescription
POLICY requiredPolicy ID (pol-...) or name.
VERSION requiredVersion number.
OptionValueDescription
--orgstrOrganization ID (default: from the profile).
--yes, -yflagDon't ask for confirmation.

tebib iam policy version list

List a policy's versions.

tebib iam policy version list [OPTIONS] POLICY
ArgumentDescription
POLICY requiredPolicy ID (pol-...) or name.
OptionValueDescription
--orgstrOrganization ID (default: from the profile).
--output, -otable | json | yamlOutput format.

tebib iam policy version show

Print one version's document.

tebib iam policy version show [OPTIONS] POLICY VERSION
ArgumentDescription
POLICY requiredPolicy ID (pol-...) or name.
VERSION requiredVersion number.
OptionValueDescription
--orgstrOrganization ID (default: from the profile).
--output, -otable | json | yamlOutput format.

tebib iam role

Roles that trusted principals assume for short-lived sessions.

tebib iam role assume

Get short-lived credentials for a role (if its trust policy allows you).

tebib iam role assume [OPTIONS] ROLE_ID
ArgumentDescription
ROLE_ID requiredRole ID (role-...).
OptionValueDescription
--session-name requiredstrShows in the audit log (2-64 chars: letters, digits, +=,.@_-).
--durationint rangeSession length in seconds (default 1 h).
--policy, -fstrSession policy JSON file (or -): narrows what the role allows.
--exportflagPrint shell export lines for the credentials.
--save-profileNAMESave the session as this profile (endpoint and organization copied).
--orgstrOrganization ID (default: from the profile).
--output, -otable | json | yamlOutput format.

tebib iam role create

Create a role. Attach policies to it with tebib iam attachment attach.

tebib iam role create [OPTIONS] NAME
ArgumentDescription
NAME requiredRole name (letters, digits, +=,.@_-).
OptionValueDescription
--trust-policy, -f requiredstrTrust policy JSON file, or - for stdin.
--descriptionstrDescription.
--max-sessionint rangeLongest session in seconds (900-43200). Default: 3600.
--tagKEY=VALUE (repeatable)Tag as KEY=VALUE; repeat for more tags.
--permission-boundarystrCap this principal with a policy (ID, name or TRN): its policies then grant only what the boundary also allows.
--orgstrOrganization ID (default: from the profile).
--output, -otable | json | yamlOutput format.

Examples

tebib iam role create deployer --trust-policy trust.json --max-session 3600
tebib iam role create ci --trust-policy trust.json --permission-boundary ReadOnly

tebib iam role delete

Delete a role (its sessions end).

tebib iam role delete [OPTIONS] ROLE_ID
ArgumentDescription
ROLE_ID requiredRole ID (role-...).
OptionValueDescription
--orgstrOrganization ID (default: from the profile).
--yes, -yflagDon't ask for confirmation.

tebib iam role list

List roles.

tebib iam role list [OPTIONS]
OptionValueDescription
--orgstrOrganization ID (default: from the profile).
--limitint rangeShow at most this many items.
--output, -otable | json | yamlOutput format.

tebib iam role revoke-sessions

End every session of a role now (e.g. after a leak).

tebib iam role revoke-sessions [OPTIONS] ROLE_ID
ArgumentDescription
ROLE_ID requiredRole ID (role-...).
OptionValueDescription
--orgstrOrganization ID (default: from the profile).
--yes, -yflagDon't ask for confirmation.

tebib iam role show

Show a role and its trust policy.

tebib iam role show [OPTIONS] ROLE_ID
ArgumentDescription
ROLE_ID requiredRole ID (role-...).
OptionValueDescription
--orgstrOrganization ID (default: from the profile).
--output, -otable | json | yamlOutput format.

tebib iam role update

Change a role's trust policy, description, session length or tags.

tebib iam role update [OPTIONS] ROLE_ID
ArgumentDescription
ROLE_ID requiredRole ID (role-...).
OptionValueDescription
--trust-policy, -fstrNew trust policy file, or -.
--descriptionstrNew description.
--max-sessionint rangeLongest session in seconds.
--tagKEY=VALUE (repeatable)Replace ALL tags (KEY=VALUE, repeatable).
--orgstrOrganization ID (default: from the profile).
--output, -otable | json | yamlOutput format.

tebib iam service-account

Non-human identities for CI and automation.

tebib iam service-account create

Create a service account (then: tebib key create --service-account <id>).

tebib iam service-account create [OPTIONS] NAME
ArgumentDescription
NAME requiredName, unique in the organization.
OptionValueDescription
--descriptionstrDescription.
--tagKEY=VALUE (repeatable)Tag as KEY=VALUE; repeat for more tags.
--permission-boundarystrCap this principal with a policy (ID, name or TRN): its policies then grant only what the boundary also allows.
--orgstrOrganization ID (default: from the profile).
--output, -otable | json | yamlOutput format.

Examples

tebib iam service-account create ci --tag team=web

tebib iam service-account delete

Delete a service account and its access keys.

tebib iam service-account delete [OPTIONS] SA_ID
ArgumentDescription
SA_ID requiredService account ID (sa-...).
OptionValueDescription
--orgstrOrganization ID (default: from the profile).
--yes, -yflagDon't ask for confirmation.

tebib iam service-account list

List service accounts.

tebib iam service-account list [OPTIONS]
OptionValueDescription
--orgstrOrganization ID (default: from the profile).
--limitint rangeShow at most this many items.
--output, -otable | json | yamlOutput format.

tebib iam service-account show

Show a service account.

tebib iam service-account show [OPTIONS] SA_ID
ArgumentDescription
SA_ID requiredService account ID (sa-...).
OptionValueDescription
--orgstrOrganization ID (default: from the profile).
--output, -otable | json | yamlOutput format.

tebib iam service-account update

Change a service account's description, tags or status.

tebib iam service-account update [OPTIONS] SA_ID
ArgumentDescription
SA_ID requiredService account ID (sa-...).
OptionValueDescription
--descriptionstrNew description.
--tagKEY=VALUE (repeatable)Replace ALL tags (KEY=VALUE, repeatable).
--disable, --enableflagRefuse (or accept again) its access keys.
--orgstrOrganization ID (default: from the profile).
--output, -otable | json | yamlOutput format.

tebib iam settings

Credential rules: key lifetimes and the unused-key limit.

tebib iam settings set

Change the unused-key limit (pass --unused-key-days N or --no-unused-key-limit).

tebib iam settings set [OPTIONS]
OptionValueDescription
--unused-key-daysint rangeTurn off active access keys unused for this many days.
--no-unused-key-limitflagNever turn off unused access keys.
--orgstrOrganization ID (default: from the profile).
--output, -otable | json | yamlOutput format.

Examples

tebib iam settings set --unused-key-days 60 # or --no-unused-key-limit (default 90)

tebib iam settings show

Show the organization's credential rules.

tebib iam settings show [OPTIONS]
OptionValueDescription
--orgstrOrganization ID (default: from the profile).
--output, -otable | json | yamlOutput format.

tebib iam user

Organization members.

tebib iam user list

List the organization's members.

tebib iam user list [OPTIONS]
OptionValueDescription
--orgstrOrganization ID (default: from the profile).
--limitint rangeShow at most this many items.
--output, -otable | json | yamlOutput format.

Examples

tebib iam user list | show | update --tag k=v | remove

tebib iam user remove

Remove a member from the organization (their keys go, their account stays).

tebib iam user remove [OPTIONS] USER_ID
ArgumentDescription
USER_ID requiredUser ID (u-...).
OptionValueDescription
--orgstrOrganization ID (default: from the profile).
--yes, -yflagDon't ask for confirmation.

Examples

tebib iam user list | show | update --tag k=v | remove

tebib iam user show

Show one member.

tebib iam user show [OPTIONS] USER_ID
ArgumentDescription
USER_ID requiredUser ID (u-...).
OptionValueDescription
--orgstrOrganization ID (default: from the profile).
--output, -otable | json | yamlOutput format.

Examples

tebib iam user list | show | update --tag k=v | remove

tebib iam user update

Set a member's tags (policies see them as principal:tag/<key>) and/or permission boundary.

tebib iam user update [OPTIONS] USER_ID
ArgumentDescription
USER_ID requiredUser ID (u-...).
OptionValueDescription
--tagKEY=VALUE (repeatable)Replace ALL tags (KEY=VALUE, repeatable).
--clear-tagsflagRemove all tags.
--permission-boundarystrCap this principal with a policy (ID, name or TRN): its policies then grant only what the boundary also allows.
--orgstrOrganization ID (default: from the profile).
--output, -otable | json | yamlOutput format.

Examples

tebib iam user list | show | update --tag k=v | remove