Add user to organization

POST

/api/v1/organizations/{organizationId}/members

curl --request POST \
  --url https://localhost:8080/api/v1/organizations/example/members \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "roles": [ "organization_owner", "project_owner" ], "userId": "example" }'

Add a user to an organization with the specified roles and best-effort sync the membership to the bound IDP organization

Authorizations

• BearerAuth
• ApiKeyAuth

Parameters

Path Parameters

organizationId

required

string

Organization ID (integer)

Request Body

Roles to assign

Media type application/json

object

roles

Array<string>

Example

[
  "organization_owner",
  "project_owner"
]

userId

required

string

Responses

201

User added successfully

Media type application/json

object

joinedAt

string

organizationId

integer

roles

Array<string>

status

string

Example ^generated

{
  "joinedAt": "example",
  "organizationId": 1,
  "roles": [
    "example"
  ],
  "status": "example"
}

400

Invalid request

Media type application/json

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

401

Unauthorized

Media type application/json

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

403

Forbidden - requires Organization Owner role

Media type application/json

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

409

User is already a member of this organization

Media type application/json

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

500

Internal server error

Media type application/json

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}