PingOne Platform APIs

Resend Admin Invite

   

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

The POST /environments/{{envID}}/users/{{userID}} operation re-sends an admin invitation. The userId of the recipient user is specified in the request URL.

The Content-Typein the request header is set to application/vnd.pingidentity.user.invite+json.

In the request body:

  • An optional invite expirationMinutes value may be set. If left blank, the default value is 60.

If successful, the response returns a 201 Created message and the user resource’s property data. A new admin registration invitation and inviteCode is generated and sent to the user’s provided email address. Previous inviteCode values are invalidated.

Prerequisites

Request Model
Property Type Required?

invite.expirationMinutes

String

Optional

Refer to the Users data model for full property descriptions.

Headers

Authorization      Bearer {{accessToken}}

Content-Type      application/vnd.pingidentity.user.invite+json

Body

raw ( application/vnd.pingidentity.user.invite+json )

{
   "invite": {
     "expirationMinutes": 120
   }
}

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.user.invite+json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
   "invite": {
     "expirationMinutes": 120
   }
}'
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.user.invite+json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
var body = @"{" + "\n" +
@"   ""invite"": {" + "\n" +
@"     ""expirationMinutes"": 120" + "\n" +
@"   }" + "\n" +
@"}" + "\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(`{
   "invite": {
     "expirationMinutes": 120
   }
}`)

  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.user.invite+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.user.invite+json
Authorization: Bearer {{accessToken}}

{
   "invite": {
     "expirationMinutes": 120
   }
}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/vnd.pingidentity.user.invite+json");
RequestBody body = RequestBody.create(mediaType, "{\n   \"invite\": {\n     \"expirationMinutes\": 120\n   }\n}\n");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/users/{{userID}}")
  .method("POST", body)
  .addHeader("Content-Type", "application/vnd.pingidentity.user.invite+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.user.invite+json",
    "Authorization": "Bearer {{accessToken}}"
  },
  "data": JSON.stringify({
    "invite": {
      "expirationMinutes": 120
    }
  }),
};

$.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.user.invite+json',
    'Authorization': 'Bearer {{accessToken}}'
  },
  body: JSON.stringify({
    "invite": {
      "expirationMinutes": 120
    }
  })

};
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({
  "invite": {
    "expirationMinutes": 120
  }
})
headers = {
  'Content-Type': 'application/vnd.pingidentity.user.invite+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.user.invite+json',
  'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('{\n   "invite": {\n     "expirationMinutes": 120\n   }\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.user.invite+json"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = JSON.dump({
  "invite": {
    "expirationMinutes": 120
  }
})

response = http.request(request)
puts response.read_body
let parameters = "{\n   \"invite\": {\n     \"expirationMinutes\": 120\n   }\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.user.invite+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/59b11a3f-d8a4-48ae-bd05-c4b3c43c490b"
        },
        "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/937d1895-c40a-4e5a-880e-7510e932fa1a"
        },
        "devices": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/59b11a3f-d8a4-48ae-bd05-c4b3c43c490b/devices"
        },
        "roleAssignments": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/59b11a3f-d8a4-48ae-bd05-c4b3c43c490b/roleAssignments"
        },
        "password": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/59b11a3f-d8a4-48ae-bd05-c4b3c43c490b/password"
        },
        "password.reset": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/59b11a3f-d8a4-48ae-bd05-c4b3c43c490b/password"
        },
        "password.set": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/59b11a3f-d8a4-48ae-bd05-c4b3c43c490b/password"
        },
        "password.check": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/59b11a3f-d8a4-48ae-bd05-c4b3c43c490b/password"
        },
        "password.recover": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/59b11a3f-d8a4-48ae-bd05-c4b3c43c490b/password"
        },
        "linkedAccounts": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/59b11a3f-d8a4-48ae-bd05-c4b3c43c490b/linkedAccounts"
        },
        "account.sendVerificationCode": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/59b11a3f-d8a4-48ae-bd05-c4b3c43c490b"
        },
        "memberOfGroups": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/59b11a3f-d8a4-48ae-bd05-c4b3c43c490b/memberOfGroups"
        }
    },
    "id": "59b11a3f-d8a4-48ae-bd05-c4b3c43c490b",
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "account": {
        "canAuthenticate": false,
        "status": "OK"
    },
    "createdAt": "2024-08-19T15:40:44.172Z",
    "email": "joeygallotta@pingidentity.com",
    "enabled": true,
    "identityProvider": {
        "type": "PING_ONE"
    },
    "invite": {
        "expiresAt": "2024-08-19T17:40:55.370Z"
    },
    "lifecycle": {
        "status": "INVITED"
    },
    "mfaEnabled": false,
    "name": {
        "given": "Mary",
        "family": "Sample"
    },
    "population": {
        "id": "937d1895-c40a-4e5a-880e-7510e932fa1a"
    },
    "updatedAt": "2024-08-19T15:40:55.421Z",
    "username": "someone@example.com",
    "verifyStatus": "NOT_INITIATED"
}