ByCloud Docs
GuidesCLIAPISDK

Add user to organization

bycloud iam users create --email <email> [flags]

Add a user to the organization by email. If the user already exists in the platform, they are added immediately. If not, an invitation email is sent and the user will be added upon accepting the invitation. Optionally specify groups to add the user to.

Options

--output

(-o)

stringoptional

Output format: text, json, or yaml

Values: "text", "json", "yaml"

Default: "text"

Body Options

--email

stringrequired

Email of the user to add

--group_ids

arrayoptional

IDs of groups to add the user to

Command

bycloud iam users create \
  --email "user@example.com"

Output

USER
  ID          550e8400-e29b-41d4-a716-446655440000
  CRN         crn::iam:user:550e8400-e29b-41d4-a716-446655440000
  EMAIL       john.doe@acme.com
  NAME        John Doe
  GROUPS
    [0]
      ID          550e8400-e29b-41d4-a716-446655440000
      NAME        string
    [1]
      ID          550e8400-e29b-41d4-a716-446655440000
      NAME        string
  ADDED_AT    2024-01-15T10:30:00Z
INVITATION
  ID          550e8400-e29b-41d4-a716-446655440000
  EMAIL       jane.doe@example.com
  GROUPS
    [0]
      ID          550e8400-e29b-41d4-a716-446655440000
      NAME        string
    [1]
      ID          550e8400-e29b-41d4-a716-446655440000
      NAME        string
  INVITED_BY
    ID          550e8400-e29b-41d4-a716-446655440000
    NAME        string
    EMAIL       user@example.com
  STATUS      pending
  EXPIRES_AT  2024-01-15T10:30:00Z
  CREATED_AT  2024-01-15T10:30:00Z
STATUS      added