Create a group membership.

POST

/api/admin/field-mapping/groups/{groupId}/memberships

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/field-mapping/groups/example/memberships \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "subjectId": "subject_123", "membershipType": "member" }'

Creates or records membership for the path group. The groupId path parameter overrides any group id supplied in the request body, and the mutation returns the created membership in a result envelope.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

groupId

required

string

Header Parameters

Idempotency-Key

string

Idempotency key for state-changing operations that support replay protection.

Request Body ^required

Media type application/json

object

subjectId

string

accountId

string

membershipType

string

assignmentSource

string

ownershipPolicy

string

Allowed values: source_owned manual protected

revokePolicy

string

Allowed values: auto review keep

protectedUntil

integer | null

key

additional properties

Example

{
  "subjectId": "subject_123",
  "membershipType": "member"
}

Responses

200

Group membership mutation response.

Media type application/json

object

result

required

object

id

required

string

tenantId

required

string

groupId

required

string

subjectId

string | null

accountId

string | null

lifecycleState

required

string

key

additional properties

key

additional properties

Example ^generated

{
  "result": {
    "id": "example",
    "tenantId": "example",
    "groupId": "example",
    "subjectId": "example",
    "accountId": "example",
    "lifecycleState": "example"
  }
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

409

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}