Organization¶

rio organization¶

Interact with organizations.

In rapyuta.io, an organization is the top-level entity that contains all the projects and resources. Using the CLI, you can view and select organizations, it’s users, invite users, and remove users.

Note that in order to invite or remove users, you need to login as the organization admin.

rio organization [OPTIONS] COMMAND [ARGS]...

inspect¶

Inspect an organization.

Provides an overview of the organization. The output is not the exact ouptut of the API, but a more human-readable version of the organization details.

rio organization inspect [OPTIONS] ORGANIZATION_NAME

Options

-f, --format <format_type>¶

Options:: json | yaml

Arguments

ORGANIZATION_NAME¶: Required argument

invite-user¶

Invite a new user to the current organization.

If the user does not have a rapyuta.io account, they will receive an email with an invitation to join the organization. If the user already has an account, they will be added to the organization.

Usage Examples:

Add a new user to the organization

$ rio organization invite-user user@email.com

rio organization invite-user [OPTIONS] USER_EMAIL

Arguments

USER_EMAIL¶: Required argument

list¶

List all the organizations for the current user.

You will only see the organizations that you are a part of. The current organization is highlighted in green.

rio organization list [OPTIONS]

remove-user¶

Remove a user from the current organization

rio organization remove-user [OPTIONS] USER_EMAIL

Arguments

USER_EMAIL¶: Required argument

select¶

Set the current organization.

You can set the current organization using the name or the guid of the organization. You will be prompted to select a project if you are running the command in an interactive mode.

To simply set the organization without selecting a project, use the –no-interactive or –silent flag.

If your organization name has spaces, use quotes around the name.

Usage Examples:

Set the current organization to ‘Platform JP Staging’

$ rio organization select ‘Platform JP Staging’

Set the current organization to ‘Platform JP Staging’ without selecting a project

$ rio organization select ‘Platform JP Staging’ –silent

rio organization select [OPTIONS] ORGANIZATION_NAME

Options

--interactive, --interactive, --no-interactive, --silent¶: Make the selection interactive

Arguments

ORGANIZATION_NAME¶: Required argument

users¶

Lists all users in the organization.

rio organization users [OPTIONS]