Update a pending directory user

POST

/api/admin/tenants/{tenantId}/directory-connectors/pending-users/{pendingId}

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/tenants/example/directory-connectors/pending-users/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "action": "reject", "reason": "No matching SCIM user" }'

Approves, rejects, or links a pending directory identity to an existing Authrim user.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

tenantId

required

string

pendingId

required

string

Request Body ^required

Pending directory user action.

Media type application/json

object

action

required

string

Allowed values: approve reject link

user_id

Existing Authrim user ID. Required when action is link.

string

reason

string

<= 1000 characters

key

additional properties

Examples

{
  "action": "reject",
  "reason": "No matching SCIM user"
}

{
  "action": "link",
  "user_id": "user_123",
  "reason": "SCIM profile verified"
}

Responses

200

Pending directory user action result.

Media type application/json

object

ok

required

boolean

id

required

string

status

required

string

Allowed values: approved rejected linked

linked_user_id

string

key

additional properties

Example

{
  "ok": true,
  "id": "dirpending_123",
  "status": "linked",
  "linked_user_id": "user_123"
}

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