Skip to content
Olivares AI docs

Grant a user a role in a tenant

POST
/v1/memberships
 
curl --request POST \
  --url https://example.com/v1/memberships \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "role": "example", "tenant": "example", "user_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "workspace_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Grants one user a role in a tenant.

Authorizations

Section titled “ Authorizations ”

Request Body required

Section titled “ Request Body required ”
Media type application/json
object
role
required
string
tenant
required
string
user_id
required
string format: uuid
workspace_id

Optional: confine the membership to one workspace of the tenant; empty is tenant-wide

string format: uuid
Example generated 
{
  "role": "example",
  "tenant": "example",
  "user_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "workspace_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Responses

Section titled “ Responses ”

201

Section titled “ 201 ”

Created

Media type application/json
object
id
string format: uuid
role
string
tenant
string
user_id
string format: uuid
Example generated 
{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "role": "example",
  "tenant": "example",
  "user_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

202

Section titled “ 202 ”

Consent required: the account exists and is not a member of the tenant; nothing was written

Media type application/json
object
status
required
string
Allowed values: consent_required
Example 
{
  "status": "consent_required"
}

400

Section titled “ 400 ”

Bad request

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

401

Section titled “ 401 ”

Unauthenticated

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

403

Section titled “ 403 ”

Forbidden

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

404

Section titled “ 404 ”

Not found

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

409

Section titled “ 409 ”

Conflict / setup required

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

429

Section titled “ 429 ”

Rate limited

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}