ByCloud Docs
GuidesCLIAPISDK
post/v1/iam/users

Add user to organization

Add a platform user to the organization. The user must already exist in the platform.

Request Body

required

Content-Type: application/json

email

string<email>required

Email of the platform user to add

Responses

201

User added

Content-Type: application/json

user

objectoptional

A platform user linked to this organization for IAM

400

Invalid request parameters

Content-Type: application/json

error

objectrequired
401

Authentication required or token invalid

Content-Type: application/json

error

objectrequired
403

Insufficient permissions

Content-Type: application/json

error

objectrequired
404

Platform user not found

Content-Type: application/json

error

objectrequired
409

User is already a member

Content-Type: application/json

error

objectrequired
500

Internal server error

Content-Type: application/json

error

objectrequired
curl -X POST "https://api.spo1.mycloud.com/v1/iam/users" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "john.doe@acme.com"
  }'

Response

User added

{
  "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": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "string"
      }
    ],
    "added_at": "2024-01-15T10:30:00Z"
  }
}