PingOne Platform APIs

User Admin Invitations

The users endpoint supports operations to send administrator invitations to users.

User invitations data model

Property Type Required Mutable Description

invite.acceptUrl

String

Optional

Mutable

The URL where the invited user can accept the invitation.

invite.expirationMinutes

String

Optional

Mutable

How long the invite is valid for, represented in minutes.

invite.isAdmin

Boolean

Required

Mutable

Indicates if the invitation is an admin invitation.

For more user property descriptions, refer to the Users data model.

Response codes

Code Message

200

Successful operation.

204

Successfully removed. No content.

400

The request could not be completed.

401

You do not have access to this resource.

404

The requested resource was not found.

Admin invitation errors

In addition to the general error codes, admin invitation operations can return the following errors:

HTTP status Top‑level code Detail code When it happens and what the response contains

400

INVALID_DATA

INVALID_VALUE

Message: The request could not be completed. One or more validation errors were in the request.

When and details

When: A POST /users request with the application/vnd.pingidentity.user.invite+json content type sets invite.isAdmin to false

Details: The value false is not supported.

400

INVALID_DATA

EMPTY_VALUE or INVALID_VALUE

Message: Validation Error : [<field> <message>]

When and details

When: A POST /users invite request omits email, name.given, name.family, or invite (EMPTY_VALUE), or supplies an email that fails email validation, a name that fails person‑name validation, an invite.acceptUrl that fails URL validation, or an invite.expirationMinutes outside 1–1440 (INVALID_VALUE)

Details: Describes the failing field, such as must not be null for an omitted email or invite relationship, must not be empty for an omitted name.family, must be a well-formed email address for an invalid email, must be a valid URL for an invalid invite.acceptUrl, or must be between 1 and 1440, inclusive for an invite.expirationMinutes outside the range, for example Validation Error : [email must not be null]

400

REQUEST_FAILED

CONSTRAINT_VIOLATION

Message: The request could not be completed. There was an issue processing the request.

When and details

When: A resend request targets a user without an email address, or the invite or its expiration is missing and it is considered expired (internal accept and lookup operations)

Details: The user does not have an email address, The invite or expiration is null and considered expired, or The invite expired at <expiresAt>

400

INVALID_REQUEST

INVALID_VALUE

Message: The request could not be completed. The request was malformed or invalid.

When and details

When: A request body cannot be deserialized as JSON

Details: Invalid value for attribute. with the target set to the field path for a JSON field conversion error, or with no target for other JSON parse failures.

400

INVALID_REQUEST

None

Message: The request could not be completed. One or more validation errors were in the request.

When and details

When: A path identifier cannot be parsed as a UUID

Details: None.

403

ACCESS_FAILED

LICENSE_EXCEEDED

Message: The request could not be completed. You do not have access to this resource.

When and details

When: The environment’s licensed product does not support sending an invite code message

Details: This environment’s licensed product does not support sending an invite code message.

403

ACCESS_FAILED

None

Message: The actor attempting to perform the request is not authorized.

When and details

When: The actor lacks the dir:invite:user permission, or is not authorized for the target user’s population

Details: None.

404

NOT_FOUND

None

Message: The request could not be completed. The requested resource was not found.

When and details

When: The user ID or environment ID in the request URL does not exist

Details: None.