PingOne Platform APIs

User Account Lock

 

POST {{apiPath}}/environments/{{envID}}/users/{{userID}}

The POST {{apiPath}}/environments/{{envID}}/users/{{userID}} endpoint is called by an administrator or an application to lock a user’s account. This operation uses the application/vnd.pingidentity.account.lock+json custom media type as the content type in the request header.

The sample shows the POST {{apiPath}}/environments/{{envID}}/users/{{userID}} operation to lock an account for the user identified by the user ID and environment ID. This operation takes an optional unlockAt property to include a timestamp that specifies when the user account will be unlocked automatically. If unlockAt is not set or is in the past, the user account is not locked.

This POST request returns a 200 OK message when successful and generates a USER.LOCKED event. When unlockAt expires, the user is unlocked but this action does not generate a USER.UNLOCKED event.

Prerequisites

Headers

Authorization      Bearer {{accessToken}}

Content-Type      application/vnd.pingidentity.account.lock+json

Body

raw ( application/vnd.pingidentity.account.lock+json )

{
  "unlockAt": "2023-06-07T23:59:59Z"
}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{apiPath}}/environments/{{envID}}/users/{{userID}}' \
--header 'Content-Type: application/vnd.pingidentity.account.lock+json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
  "unlockAt": "2023-06-07T23:59:59Z"
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/users/{{userID}}")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/vnd.pingidentity.account.lock+json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
var body = @"{" + "\n" +
@"  ""unlockAt"": ""2023-06-07T23:59:59Z""" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "{{apiPath}}/environments/{{envID}}/users/{{userID}}"
  method := "POST"

  payload := strings.NewReader(`{
  "unlockAt": "2023-06-07T23:59:59Z"
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/vnd.pingidentity.account.lock+json")
  req.Header.Add("Authorization", "Bearer {{accessToken}}")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}
POST /environments/{{envID}}/users/{{userID}} HTTP/1.1
Host: {{apiPath}}
Content-Type: application/vnd.pingidentity.account.lock+json
Authorization: Bearer {{accessToken}}

{
  "unlockAt": "2023-06-07T23:59:59Z"
}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/vnd.pingidentity.account.lock+json");
RequestBody body = RequestBody.create(mediaType, "{\n  \"unlockAt\": \"2023-06-07T23:59:59Z\"\n}");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/users/{{userID}}")
  .method("POST", body)
  .addHeader("Content-Type", "application/vnd.pingidentity.account.lock+json")
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/users/{{userID}}",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/vnd.pingidentity.account.lock+json",
    "Authorization": "Bearer {{accessToken}}"
  },
  "data": JSON.stringify({
    "unlockAt": "2023-06-07T23:59:59Z"
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'POST',
  'url': '{{apiPath}}/environments/{{envID}}/users/{{userID}}',
  'headers': {
    'Content-Type': 'application/vnd.pingidentity.account.lock+json',
    'Authorization': 'Bearer {{accessToken}}'
  },
  body: JSON.stringify({
    "unlockAt": "2023-06-07T23:59:59Z"
  })

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
import requests
import json

url = "{{apiPath}}/environments/{{envID}}/users/{{userID}}"

payload = json.dumps({
  "unlockAt": "2023-06-07T23:59:59Z"
})
headers = {
  'Content-Type': 'application/vnd.pingidentity.account.lock+json',
  'Authorization': 'Bearer {{accessToken}}'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/environments/{{envID}}/users/{{userID}}');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Content-Type' => 'application/vnd.pingidentity.account.lock+json',
  'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('{\n  "unlockAt": "2023-06-07T23:59:59Z"\n}');
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}
require "uri"
require "json"
require "net/http"

url = URI("{{apiPath}}/environments/{{envID}}/users/{{userID}}")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/vnd.pingidentity.account.lock+json"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = JSON.dump({
  "unlockAt": "2023-06-07T23:59:59Z"
})

response = http.request(request)
puts response.read_body
let parameters = "{\n  \"unlockAt\": \"2023-06-07T23:59:59Z\"\n}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/users/{{userID}}")!,timeoutInterval: Double.infinity)
request.addValue("application/vnd.pingidentity.account.lock+json", forHTTPHeaderField: "Content-Type")
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")

request.httpMethod = "POST"
request.httpBody = postData

let task = URLSession.shared.dataTask(with: request) { data, response, error in
  guard let data = data else {
    print(String(describing: error))
    return
  }
  print(String(data: data, encoding: .utf8)!)
}

task.resume()

Example Response

200 OK

{
    "_links": {
        "self": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/5282e30d-6e05-499c-ae68-0069fba776f1"
        },
        "environment": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
        },
        "population": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/populations/d997657f-38c4-435f-b85e-efb71799ea34"
        },
        "devices": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/5282e30d-6e05-499c-ae68-0069fba776f1/devices"
        },
        "roleAssignments": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/5282e30d-6e05-499c-ae68-0069fba776f1/roleAssignments"
        },
        "password": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/5282e30d-6e05-499c-ae68-0069fba776f1/password"
        },
        "password.reset": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/5282e30d-6e05-499c-ae68-0069fba776f1/password"
        },
        "password.set": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/5282e30d-6e05-499c-ae68-0069fba776f1/password"
        },
        "password.check": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/5282e30d-6e05-499c-ae68-0069fba776f1/password"
        },
        "password.recover": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/5282e30d-6e05-499c-ae68-0069fba776f1/password"
        },
        "linkedAccounts": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/5282e30d-6e05-499c-ae68-0069fba776f1/linkedAccounts"
        },
        "account.unlock": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/5282e30d-6e05-499c-ae68-0069fba776f1"
        },
        "account.sendVerificationCode": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/5282e30d-6e05-499c-ae68-0069fba776f1"
        },
        "memberOfGroups": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/5282e30d-6e05-499c-ae68-0069fba776f1/memberOfGroups"
        }
    },
    "id": "5282e30d-6e05-499c-ae68-0069fba776f1",
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "account": {
        "canAuthenticate": false,
        "lockedAt": "2023-06-06T22:11:15.400Z",
        "secondsUntilUnlock": 92923,
        "status": "LOCKED",
        "unlockAt": "2023-06-07T23:59:59.000Z"
    },
    "createdAt": "2023-02-17T20:44:27.905Z",
    "email": "marysample@example.com",
    "enabled": true,
    "identityProvider": {
        "type": "PING_ONE"
    },
    "lifecycle": {
        "status": "ACCOUNT_OK"
    },
    "mfaEnabled": false,
    "name": {
        "given": "Mary",
        "family": "Sample"
    },
    "population": {
        "id": "d997657f-38c4-435f-b85e-efb71799ea34"
    },
    "updatedAt": "2023-06-06T22:11:15.401Z",
    "username": "marysample",
    "verifyStatus": "NOT_INITIATED"
}