TrieOH
PayssageAPIOrgs

Add an organization member

Adds an existing actor (by email) to the organization with the given role. The actor must be an admin or owner.

POST/organizations/{organization_id}/members

Adds an existing actor (by email) to the organization with the given role. The actor must be an admin or owner.

Authorization

bearerAuth
AuthorizationBearer <token>

JWT issued by IdentityX, signed with Ed25519

In: header

Path Parameters

organization_id*string

Organization ID.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request body for adding an organization member. Mirrors models.AddOrganizationMemberRequest.

Response Body

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/members" \  -H "Content-Type: application/json" \  -d '{    "actor_email": "user@example.com",    "role": "member"  }'
Empty
{
  "detail": "string",
  "instance": "../dictionary",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "type": "http://example.com",
  "status": 400,
  "title": "Validation Failed"
}
{
  "detail": "string",
  "instance": "../dictionary",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "type": "http://example.com",
  "status": 401,
  "title": "Unauthenticated"
}
{
  "detail": "string",
  "instance": "../dictionary",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "type": "http://example.com",
  "status": 403,
  "title": "Insufficient Role"
}
{
  "detail": "string",
  "instance": "../dictionary",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "type": "http://example.com",
  "status": 404,
  "title": "Not Found"
}
{
  "detail": "string",
  "instance": "../dictionary",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "type": "http://example.com",
  "status": 409,
  "title": "Provider Conflict",
  "provider": "string",
  "reason": "string"
}
{
  "detail": "string",
  "instance": "../dictionary",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "type": "http://example.com",
  "status": 500,
  "title": "Internal Server Error"
}

List organization members GET

Lists the members of an organization. The actor must be a member of the organization.

Remove an organization member DELETE

Removes an actor (by email) from the organization. The actor must be an admin or owner.