Skip to content
PalomPalomAtlas

Update

PATCH
/api/v1/principals/{principal_id}
curl --request PATCH \
  --url https://example.com/api/v1/principals/example \
  --header 'Content-Type: application/json' \
  --data '{ "superuser": true, "revoked": true }'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
principal_id
required
Principal Id
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
UpdatePrincipalRequest
object
superuser
Any of:
boolean
revoked
Any of:
boolean
Examplegenerated
{
  "superuser": true,
  "revoked": true
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
PrincipalSummary
object
id
required
Id
string
type
required
PrincipalType
string
Allowed values: USER API
name
required
Name
string
extra
required
Extra
object
key
additional properties
any
superuser
required
Superuser
boolean
has_secret
required
Has Secret
boolean
created_by
required
Any of:
string
created_at
required
Created At
string format: date-time
revoked_by
required
Any of:
string
revoked_at
required
Any of:
string format: date-time
Example
{
  "type": "USER"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}