Patch v2users

User management API, reserved to super admins.

PATCH /v2/users/{userId}

cURL

cURL

curl --request PATCH \
  --url https://api.eda.prisme.ai/v2/users/{userId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "[e-mail]",
  "meta": {},
  "platformRole": "<string>",
  "groups": [
    "<string>"
  ],
  "groupAcls": {}
}
'

import requests

url = "https://api.eda.prisme.ai/v2/users/{userId}"

payload = {
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "[e-mail]",
    "meta": {},
    "platformRole": "<string>",
    "groups": ["<string>"],
    "groupAcls": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    firstName: '<string>',
    lastName: '<string>',
    email: '[e-mail]',
    meta: {},
    platformRole: '<string>',
    groups: ['<string>'],
    groupAcls: {}
  })
};

fetch('https://api.eda.prisme.ai/v2/users/{userId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.eda.prisme.ai/v2/users/{userId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'firstName' => '<string>',
    'lastName' => '<string>',
    'email' => '[e-mail]',
    'meta' => [
        
    ],
    'platformRole' => '<string>',
    'groups' => [
        '<string>'
    ],
    'groupAcls' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.eda.prisme.ai/v2/users/{userId}"

	payload := strings.NewReader("{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"[e-mail]\",\n  \"meta\": {},\n  \"platformRole\": \"<string>\",\n  \"groups\": [\n    \"<string>\"\n  ],\n  \"groupAcls\": {}\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.eda.prisme.ai/v2/users/{userId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"[e-mail]\",\n  \"meta\": {},\n  \"platformRole\": \"<string>\",\n  \"groups\": [\n    \"<string>\"\n  ],\n  \"groupAcls\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.eda.prisme.ai/v2/users/{userId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"[e-mail]\",\n  \"meta\": {},\n  \"platformRole\": \"<string>\",\n  \"groups\": [\n    \"<string>\"\n  ],\n  \"groupAcls\": {}\n}"

response = http.request(request)
puts response.read_body

200

{
  "firstName": "<string>",
  "email": "[e-mail]",
  "language": "<string>",
  "authData": {
    "anonymous": {},
    "prismeai": {},
    "azure": {
      "id": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "email": "<string>",
      "language": "<unknown>"
    }
  },
  "meta": {},
  "orgSlugs": [
    "<string>"
  ],
  "platformRole": "<string>",
  "groupAcls": {},
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "updatedBy": "<string>",
  "lastName": "<string>",
  "photo": "<string>",
  "groups": [
    "<string>"
  ],
  "membership": {
    "roleSlug": "<string>",
    "joinedAt": "<string>",
    "invitedAt": "<string>",
    "invitedBy": "<string>"
  },
  "id": "<string>"
}

{
  "error": "ForbiddenError",
  "message": "Forbidden"
}

{
  "error": "ObjectNotFound",
  "message": "<string>"
}

Authorizations

BearerAuthWorkspaceApiKeyAuthBearerAuth & WorkspaceApiKeyAuth

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

userId · string · required

Target user id

Body

application/json

firstName · string

Pattern: ^[0-9A-Za-zÀ-ÖØ-öø-ÿ ,.'- ]{1,60}$

lastName · string

Pattern: ^[0-9A-Za-zÀ-ÖØ-öø-ÿ ,.'- ]{1,60}$

email · string<email>

status · enum<string>

Available options: pending, validated, deactivated

meta · object

platformRole · string

groups · string[]

groupAcls · object

Show child attributes

Response

200

application/json

Success Response

firstName · string · required

Name

email · string

Example:

"[e-mail]"

status · enum<string>

Available options: pending, validated, deactivated

language · string

authData · object

Show child attributes

mfa · enum<string>

Available options: totp, none, *

meta · object

orgSlugs · string[]

platformRole · string

groupAcls · object

Show child attributes

createdAt · string

updatedAt · string

updatedBy · string

lastName · string

Name

photo · string

Profile picture URL

groups · string[]

membership · object

Organization membership info (only returned when includeOrgMembership is set)

Show child attributes

id · string

Unique id