For a complete technical description of JSON Pointer syntax, see JavaScript Object Notation (JSON) Pointer on ietf.org.

For more information, see the following sections of the PingOne API documentation:
  • READ One User for the PingOne JSON payload structure
  • Users (User Properties section) for descriptions of the user properties

Example JSON payload

{
    "_links": {
        "self": {
            "href": "https://api.pingone.com/v1/environments/5da98f13-ad62-4234-ba04-2b3e2a05c8ca/users/c3042000-188f-4bc7-a269-d0a1602cf5baf"
        },
        "environment": {
            "href": "https://api.pingone.com/v1/environments/5da98f13-ad62-4234-ba04-2b3e2a05c8ca"
        },
        "population": {
            "href": "https://api.pingone.com/v1/environments/5da98f13-ad62-4234-ba04-2b3e2a05c8ca/populations/a701eb22-849d-4168-b756-6c20fc087c2f"
        },
        "password": {
            "href": "https://api.pingone.com/v1/environments/5da98f13-ad62-4234-ba04-2b3e2a05c8ca/users/c3042000-188f-4bc7-a269-d0a1602cf5baf/password"
        },
        "password.reset": {
            "href": "https://api.pingone.com/v1/environments/5da98f13-ad62-4234-ba04-2b3e2a05c8ca/users/c3042000-188f-4bc7-a269-d0a1602cf5baf/password"
        },
        "password.set": {
            "href": "https://api.pingone.com/v1/environments/5da98f13-ad62-4234-ba04-2b3e2a05c8ca/users/c3042000-188f-4bc7-a269-d0a1602cf5baf/password"
        },
        "password.validate": {
            "href": "https://api.pingone.com/v1/environments/5da98f13-ad62-4234-ba04-2b3e2a05c8ca/users/c3042000-188f-4bc7-a269-d0a1602cf5baf/password"
        },
        "password.recover": {
            "href": "https://api.pingone.com/v1/environments/5da98f13-ad62-4234-ba04-2b3e2a05c8ca/users/c3042000-188f-4bc7-a269-d0a1602cf5baf/password"
        },
        "account.sendVerificationCode": {
            "href": "https://api.pingone.com/v1/environments/5da98f13-ad62-4234-ba04-2b3e2a05c8ca/users/c3042000-188f-4bc7-a269-d0a1602cf5baf"
        }
    },
    "id": "c3042000-188f-4bc7-a269-d0a1602cf5baf",
    "environment": {
        "id": "5da98f13-ad62-4234-ba04-2b3e2a05c8ca"
    },
    "population": {
        "id": "a701o5ad-849d-4168-b756-6c20fc087c2f"
    },
    "createdAt": "2020-01-08T20:18:31.264Z",
    "email": "jsmith@example.com",
    "enabled": true,
    "lifecycle": {
        "status": "ACCOUNT_OK"
    },
    "mfaEnabled": false,
    "name": {
        "given": "Janet",
        "family": "Smith"
    },
    "nickname": "Janet",
    "updatedAt": "2020-01-08T20:59:56.871Z",
    "username": "jsmith"
}
JSON Pointer syntax:
Description JSON Pointer Example value
First name /name/given Janet
Last name /name/family Smith
Population ID /population/id a701o5ad-849d-4168-b756-6c20fc087c2f
User ID /id c3042000-188f-4bc7-a269-d0a1602cf5baf