Add member API Reference

POST

/tenants/{tenant}/members

curl --request POST \
  --url https://api.kupe.cloud/api/v1/tenants/acme/members \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --header 'If-Match: 184920' \
  --data '{ "email": "alice@acme.com", "role": "admin" }'

Add a new member to the tenant. The email address must be unique within the tenant. The user will be able to authenticate via OIDC and access tenant resources based on their assigned role.

Authorizations

• BearerAuth

Parameters

Path Parameters

tenant

required

string

Tenant name

Header Parameters

If-Match

string

ETag for optimistic locking

Request Body

Member to add

Media type application/json

object

email

Email address of the member to add

string

Example

alice@acme.com

role

Role: admin (read-write) or readonly (read-only)

string

Example

admin

Responses

201

Member added

Media type application/json

object

email

string

role

string

Example

{
  "email": "alice@acme.com",
  "role": "admin"
}

400

Validation error

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

401

Missing or invalid authentication

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

403

Admin access required

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

409

Member already exists

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

412

ETag mismatch

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

429

Rate limit exceeded

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}