Skip to main content
PATCH
/
org
/
{org}
/
user
/
{name}
Perform a Patch on a user by name
curl --request PATCH \
  --url https://api.cpln.io/org/{org}/user/{name} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "$drop": [
    "id"
  ],
  "id": "<string>",
  "name": "<string>",
  "version": 123,
  "tags": {},
  "$replace/tags": {},
  "created": "2023-11-07T05:31:56Z",
  "lastModified": "2023-11-07T05:31:56Z",
  "idp": "<string>",
  "email": "<string>"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "kind": "<string>",
  "version": 123,
  "tags": {},
  "created": "2023-11-07T05:31:56Z",
  "lastModified": "2023-11-07T05:31:56Z",
  "links": [
    {
      "rel": "<string>",
      "href": "<string>"
    }
  ],
  "idp": "<string>",
  "email": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.controlplane.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Service account key can be used as API keys

Path Parameters

​
org
string
required
​
name
string
required

Body

application/json
​
$drop
enum<string>[]
Available options:
id,
version,
tags,
created,
lastModified,
idp,
email
​
id
string
​
name
string
​
version
number
​
tags
object
​
$replace/tags
object
​
created
string<date-time>
​
lastModified
string<date-time>
​
idp
string
​
email
string

Response

Success

​
id
string
​
name
string
​
kind
string
read-only
​
version
number
​
tags
object
​
created
string<date-time>
​
lastModified
string<date-time>
​
links
object[]
read-only
​
idp
string
​
email
string