Create an organization bulk-members job.

POST

/api/admin/jobs/organizations/{id}/bulk-members

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/jobs/organizations/example/bulk-members \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "user_ids": [ "018f3f7c-85b0-7c5d-a6b6-1c3a6e6b9e01" ], "role": "member", "action": "add", "result_delivery": "auto" }'

Queues a job to add or remove up to 1,000 active users from an organization. The handler verifies the organization and all user ids before creating a pending organizations/bulk-members job.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

id

required

string

Request Body ^required

Media type application/json

object

user_ids

required

Array<string>

>= 1 items <= 1000 items

role

string

Allowed values: member admin owner

action

string

default: add

Allowed values: add remove

result_delivery

string

Allowed values: auto inline artifact

key

additional properties

Example

{
  "user_ids": [
    "018f3f7c-85b0-7c5d-a6b6-1c3a6e6b9e01"
  ],
  "role": "member",
  "action": "add",
  "result_delivery": "auto"
}

Responses

202

Organization bulk membership job accepted response.

Media type application/json

object

job_id

required

string

status

required

string

Allowed values: pending

job_type

required

string

created_at

required

string format: date-time

estimated_completion

required

string format: date-time

organization_id

required

string

organization_name

required

string

action

required

string

Allowed values: add remove

user_count

required

integer

>= 1

role

string

Allowed values: member admin owner

Example

{
  "status": "pending",
  "action": "add",
  "role": "member"
}

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"
}