Create an invitation

POST

/v1/iam/organizations/{orgIdentityId}/invitations

curl --request POST \
  --url http://localhost:8080/v1/iam/organizations/example/invitations \
  --header 'Content-Type: application/json' \
  --data '{ "email": "hello@example.com", "roleId": "example", "firstName": "example", "lastName": "example" }'

• Dev (Bun.serve, défaut local).
• Remplacer par l'URL prod.

Parameters

Path Parameters

orgIdentityId

required

string

Request Body ^required

Media type application/json

object

email

required

string format: email

<= 255 characters

roleId

required

string

>= 1 characters

firstName

string

<= 80 characters

lastName

string

<= 80 characters

Example ^generated

{
  "email": "hello@example.com",
  "roleId": "example",
  "firstName": "example",
  "lastName": "example"
}

Responses

201

Invitation created + email sent.

Media type application/json

object

status

required

string

Allowed value: success

code

required

string

data

required

object

id

required

string

tenantId

required

string

organizationId

required

string

userId

required

string

email

required

string

roleId

required

string

status

required

string

Allowed values: pending active declined revoked renounced

invitedAt

required

string format: date-time

invitationExpiresAt

required

string | null format: date-time

cache

object

hit

required

boolean

key

string

ageSeconds

integer

expiresAt

string format: date-time

timing

object

totalMs

required

integer

dbMs

integer

externalMs

integer

deprecation

object

sunset

required

string format: date-time

successor

string

note

string

Example

{
  "status": "success",
  "data": {
    "status": "pending"
  }
}

400

Requête mal formée (validation_error, invalid_idempotency_key, invalid_sort_field, invalid_filter).

Media type application/json

object

status

required

string

Allowed value: error

code

required

string

error

required

object

message

string

requestId

required

string

details

Array<object>

object

path

string

code

string

message

string

key

additional properties

Example

{
  "status": "error"
}

401

Authentification manquante ou invalide.

Media type application/json

object

status

required

string

Allowed value: error

code

required

string

error

required

object

message

string

requestId

required

string

details

Array<object>

object

path

string

code

string

message

string

key

additional properties

Example

{
  "status": "error"
}

403

Scope insuffisant (forbidden, no_active_plan, service_disabled_on_plan).

Media type application/json

object

status

required

string

Allowed value: error

code

required

string

error

required

object

message

string

requestId

required

string

details

Array<object>

object

path

string

code

string

message

string

key

additional properties

Example

{
  "status": "error"
}

404

Ressource introuvable (ou hors-tenant).

Media type application/json

object

status

required

string

Allowed value: error

code

required

string

error

required

object

message

string

requestId

required

string

details

Array<object>

object

path

string

code

string

message

string

key

additional properties

Example

{
  "status": "error"
}

409

Conflit d’état (cannot_replay_<status>, idempotency_mismatch).

Media type application/json

object

status

required

string

Allowed value: error

code

required

string

error

required

object

message

string

requestId

required

string

details

Array<object>

object

path

string

code

string

message

string

key

additional properties

Example

{
  "status": "error"
}

422

Validation métier KO (unsafe_url, invalid_bulk_body).

Media type application/json

object

status

required

string

Allowed value: error

code

required

string

error

required

object

message

string

requestId

required

string

details

Array<object>

object

path

string

code

string

message

string

key

additional properties

Example

{
  "status": "error"
}