PingOne Platform APIs

Step 2: Create Image

     

POST {{apiPath}}/environments/{{envID}}/images

The POST {{apiPath}}/environments/{{envID}}/images endpoint associates the uploaded image file with the specified environment resource.

The request body requires you to upload an image file, and then edit the Content-Disposition header to match the file.

The request generates a userImage resource that will be used by the request in step 3.

Headers

Authorization      Bearer {{accessToken}}

Content-Type      image/jpeg

content-disposition      attachment; filename=userimg.jpg

Body

file ( image/jpeg )

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{apiPath}}/environments/{{envID}}/images' \
--header 'Content-Type: image/jpeg' \
--header 'content-disposition: attachment; filename=userimg.jpg' \
--header 'Authorization: Bearer {{accessToken}}' \
--data-binary '@kZMmKUMpW/dspanner.jpg'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/images")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "image/jpeg");
request.AddHeader("content-disposition", "attachment; filename=userimg.jpg");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
request.AddParameter("image/jpeg", "<file contents here>", ParameterType.RequestBody);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main

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

func main() {

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

  payload := strings.NewReader("<file contents here>")


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

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "image/jpeg")
  req.Header.Add("content-disposition", "attachment; filename=userimg.jpg")
  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}}/images HTTP/1.1
Host: {{apiPath}}
Content-Type: image/jpeg
content-disposition: attachment; filename=userimg.jpg
Authorization: Bearer {{accessToken}}

"<file contents here>"
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("image/jpeg");
RequestBody body = RequestBody.create(mediaType, "<file contents here>");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/images")
  .method("POST", body)
  .addHeader("Content-Type", "image/jpeg")
  .addHeader("content-disposition", "attachment; filename=userimg.jpg")
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/images",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Content-Type": "image/jpeg",
    "content-disposition": "attachment; filename=userimg.jpg",
    "Authorization": "Bearer {{accessToken}}"
  },
   "data": "<file contents here>"
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'POST',
  'url': '{{apiPath}}/environments/{{envID}}/images',
  'headers': {
    'Content-Type': 'image/jpeg',
    'content-disposition': 'attachment; filename=userimg.jpg',
    'Authorization': 'Bearer {{accessToken}}'
  },
  body: "<file contents here>"

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

url = "{{apiPath}}/environments/{{envID}}/images"

payload = "<file contents here>"
headers = {
  'Content-Type': 'image/jpeg',
  'content-disposition': 'attachment; filename=userimg.jpg',
  '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}}/images');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Content-Type' => 'image/jpeg',
  'content-disposition' => 'attachment; filename=userimg.jpg',
  'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('<file contents here>');
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 "net/http"

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

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Content-Type"] = "image/jpeg"
request["content-disposition"] = "attachment; filename=userimg.jpg"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = "<file contents here>"

response = http.request(request)
puts response.read_body
let parameters = "<file contents here>"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/images")!,timeoutInterval: Double.infinity)
request.addValue("image/jpeg", forHTTPHeaderField: "Content-Type")
request.addValue("attachment; filename=userimg.jpg", forHTTPHeaderField: "content-disposition")
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

201 Created

{
    "_links": {
        "self": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/images/99b4c866-041f-4c04-b495-be764f14927f"
        },
        "environment": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
        }
    },
    "id": "99b4c866-041f-4c04-b495-be764f14927f",
    "targets": {
        "original": {
            "id": "original",
            "width": 826,
            "height": 836,
            "type": "png",
            "href": "https://uploads.pingone.com/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/images/99b4c866-041f-4c04-b495-be764f14927f_0785480c-2fbb-47b3-ac3e-e7ee3a4e61d1_original.png"
        }
    },
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "createdAt": "2023-01-09T21:47:50.079Z"
}