Enable users settings

Users API operations

The enable/disable users endpoints support the following operations:

GET /environments/{environmentId}/users/{userId}/enabled Read enabled user setting
PUT /environments/{environmentId}/users/{userId}/enabled Update enabled user setting

For hands-on experience with the users API endpoints, click the Run in Postman button below to download a Postman collection that you can import and open in your local Postman application.

Users data model

Property	Description
`accountId`	A string that specifies the user’s account ID, which is optional. This may be explicitly set to null when updating a user to unset it. This attribute is organization-specific and has no special meaning within the PingOne platform.
`address.countryCode`	A string that specifies the country name component. When specified, the value must be in ISO 3166-1 “alpha-2” code format [ISO3166]. For example, the country codes for the United States and Sweden are “US” and “SE”, respectively.
`address.locality`	A string that specifies the city or locality component of the address.
`address.postalCode`	A string that specifies the zip code or postal code component of the address.
`address.region`	A string that specifies the state or region component of the address.
`address.streetAddress`	A string that specifies the full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information. This attribute may contain newlines.
`createdAt`	The time the resource was created.
`email`	A string that specifies the user’s email address, which must be provided and valid.
`enabled`	A read-only boolean attribute that specifies whether the user is enabled. This attribute is set to ‘true’ by default when the user is created.
`environment.id`	A string that specifies the environment resource’s unique identifier associated with the user.
`externalId`	A string that specifies an identifier for the user resource as defined by the provisioning client. This is optional. This may be explicitly set to null when updating a user to unset it. The externalId attribute may simplify the correlation of the user in PingOne with the user’s account in another system of record. The platform does not use this attribute directly in any way, but it is used by Ping Identity’s Data Sync product.
`id`	A string that specifies the user resource’s unique identifier.
`lifecycle.status`	A string that specifies information about the account lifecycle. Options for status are `ACCOUNT_OK` and `VERIFICATION_REQUIRED`. This property value is only allowed to be set when importing a user to set the initial account status. If the initial status is set to `VERIFICATION_REQUIRED` and an email address is provided, a verification email is sent.
`locale`	A string that specifies the user’s default location, which is optional. This may be explicitly set to null when updating a user to unset it. This is used for purposes of localizing such items as currency, date time format, or numerical representations. If provided, a valid value is a language tag as defined in RFC 5646. The following are example tags: fr, en-US, es-419, az-Arab, man-Nkoo-GN.
`mfaEnabled`	A read-only boolean attribute that specifies whether multi-factor authentication is enabled. This attribute is set to ‘false’ by default when the user is created.
`mobilePhone`	A string that specifies the user’s mobile phone number, which is optional. This might also match the primaryPhone attribute. This may be explicitly set to null when updating a user to unset it. If provided, it must consist of a leading plus sign, 1 to 3-digit country code, dot separator, 4 to 14-digit phone number, and optional 1 to 8-digit extension (for example, +1.3034682900x1234).
`name.family`	A string that specifies the family name of the user, or Last in most Western languages (for example, ‘Jensen’ given the full name ‘Ms. Barbara J Jensen, III’). This may be explicitly set to null when updating a name to unset it. Valid characters consists of any Unicode letter, mark (for example, accent, umlaut), space, dot, apostrophe, or hyphen. It can have a length of no more than 256 characters.
`name.formatted`	A string that specifies the fully formatted name of the user (for example ‘Ms. Barbara J Jensen, III’). This can be explicitly set to null when updating a name to unset it.
`name.given`	A string that specifies the given name of the user, or First in most Western languages (for example, ‘Barbara’ given the full name ‘Ms. Barbara J Jensen, III’). This may be explicitly set to null when updating a name to unset it. Valid characters consists of any Unicode letter, mark (for example, accent, umlaut), space, dot, apostrophe, or hyphen. It can have a length of no more than 256 characters.
`name.honorificPrefix`	A string that specifies the honorific prefix(es) of the user, or title in most Western languages (for example, ‘Ms.’ given the full name ‘Ms. Barbara Jane Jensen, III’). This can be explicitly set to null when updating a name to unset it.
`name.honorificSuffix`	A string that specifies the honorific suffix(es) of the user, or suffix in most Western languages (for example, ‘III’ given the full name ‘Ms. Barbara Jane Jensen, III’). This can be explicitly set to null when updating a name to unset it.
`name.middle`	A string that specifies the the middle name(s) of the user (for exmple, ‘Jane’ given the full name ‘Ms. Barbara Jane Jensen, III’). This can be explicitly set to null when updating a name to unset it. Valid characters consists of any Unicode letter, mark (for example, accent, umlaut), space, dot, apostrophe, or hyphen. It can have a length of no more than 256 characters.
`nickname`	A string that specifies the user’s nickname, which is optional. This can be explicitly set to null when updating a user to unset it. Valid characters consists of any Unicode letter, mark (for example, accent, umlaut), space, dot, apostrophe, or hyphen. It can have a length of no more than 256 characters.
`photo.href`	A string that specifies the URI that is a uniform resource locator (as defined in Section 1.1.3 of RFC 3986) that points to a resource location representing the user’s image. This can be removed from a user by setting the photo attribute to null. If provided, the resource must be a file (for example, a GIF, JPEG, or PNG image file) rather than a web page containing an image. It must also have a scheme of HTTP or HTTPS.
`population.id`	A string that specifies the identifier of the population resource associated with the user.
`preferredLanguage`	A string that specifies the user’s preferred written or spoken languages, which are optional. This may be explicitly set to null when updating a user to unset it. If provided, the format of the value is the same as the HTTP Accept-Language header field (not including `Accept-Language:`) and is specified in Section 5.3.5 of RFC 7231. For example: en-US, en-gb;q=0.8, en;q=0.7.
`primaryPhone`	A string that specifies the user’s primary phone number, which is optional. This might also match the mobilePhone attribute. This may be explicitly set to null when updating a user to unset it. If provided, it must consist of a leading plus sign, 1 to 3-digit country code, dot separator, 4 to 14-digit phone number, and optional 1 to 8-digit extension (for example, +1.3034682900x1234).
`timezone`	A string that specifies the user’s time zone, which is optional. This can be explicitly set to null when updating a user to unset it. If provided, it must conform with the IANA Time Zone database format [RFC6557], also known as the “Olson” time zone database format [Olson-TZ] for example, “America/Los_Angeles”).
`title`	A string that specifies the user’s title, which is optional, such as “Vice President”. This can be explicitly set to null when updating a user to unset it.
`type`	A string that specifies the user’s type, which is optional. This can be explicitly set to null when updating a user to unset it. This attribute is organization-specific and has no special meaning within the PingOne platform. It could have values of “Contractor”, “Employee”, “Intern”, “Temp”, “External”, and “Unknown”.
`updatedAt`	The time the resource was last updated.
`username`	A string that specifies the user name, which must be provided and must be unique within an environment. The `username` must either be a well-formed email address or a string of any Unicode letter, mark (for example, accent, umlaut), dot, underscore, or hyphen. It can have a length of no more than 128 characters.

Response codes

Code	Message
200	Successful operation.
201	Successfully created.
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.
409	A resource with the specified name already exists.

Endpoint examples

Get user enabled setting

When a new user resource is created, the value specified for the enabled attribute determines the user’s ability to authenticate. If the enabled attribute is omitted from the POST request, the value is set to true by default.

For existing users, you can use the GET /environments/{environmentId}/users/{userId}/enabled operation to check whether the specified user is enabled or disabled.

curl -X "GET" "https://api.pingone.com/v1/environments/{environmentId}/users/{userId}/enabled" \
-H 'Authorization: Bearer jwtToken'

The response data for an enabled user looks like this:

{
    "_links": {
        "self": {
            "href": "https://api.pingone.com/v1/environments/02d37832-476a-431b-8a60-d77cecd7005c/users/9a774ad6-b6b6-4179-af87-226cd68955f0/enabled"
        },
        "user": {
            "href": "https://api.pingone.com/v1/environments/02d37832-476a-431b-8a60-d77cecd7005c/users/9a774ad6-b6b6-4179-af87-226cd68955f0"
        }
    },
    "enabled": true
}

Update user enabled setting

You can modify the user’s enabled attribute value by calling the PUT /environments/{environmentId}/users/{userId}/enabled endpoint.

The following sample shows the PUT /environments/{environmentId}/users/{userId}/enabled operation to disable the user resource’s ability to authenticate.

curl -X "PUT" "https://api.pingone.com/v1/environments/{environmentId}/users/{userId}/enabled" \
-H 'Content-type: application/json' \
-H 'Authorization: Bearer jwtToken' \
-d $'{
  "enabled": "false"
}'

The response data with the updated setting looks like this:

{
    "_links": {
        "self": {
            "href": "https://api.pingone.com/v1/environments/02d37832-476a-431b-8a60-d77cecd7005c/users/9a774ad6-b6b6-4179-af87-226cd68955f0/enabled"
        },
        "user": {
            "href": "https://api.pingone.com/v1/environments/02d37832-476a-431b-8a60-d77cecd7005c/users/9a774ad6-b6b6-4179-af87-226cd68955f0"
        }
    },
    "enabled": false
}