Add Organization Member

POST 
/v1/organization/members/add

⚠️ WARNING

This endpoint is unstable & not officially supported. It may be deprecated and removed in future API versions.

Add Organization Member

Request

application/json

Body

required

user_id

object

Unique user id

anyOf

MOD1

string

email

object

The email address associated with an Atlas account

anyOf

MOD1

string

access_role AccessRole (string)required

Possible values: [OWNER, ADMIN, MEMBER, VIEWER, EXTERNAL, GUEST, NONE]

The access role the new user should have: MEMBER, ADMIN, OWNER

organization_id Organization Id (string)required

Unique organization id

Responses

201

Successful Response

application/json

Schema

Schema

result Result (string)

Default value: ok

Example (from schema)

{
  "result": "ok"
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...