Update a user seat

PATCH

https://api.cloudflare.com/client/v4/accounts/{identifier}/access/seats

Last modified:2022-12-16 13:48:36

Removes a user from a Zero Trust seat when both access_seat and gateway_seat are set to false.

Request

Path Params

identifier

string

required

Body Params application/json

array of:

access_seat

boolean

required

True if the seat is part of Access.

Example:

false

gateway_seat

boolean

required

True if the seat is part of Gateway.

Example:

false

seat_uid

required

The unique API identifier for the Zero Trust seat.

Example

[
    {
        "access_seat": false,
        "gateway_seat": false,
        "seat_uid": null
    }
]

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://api.cloudflare.com/client/v4/accounts//access/seats' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "access_seat": false,
        "gateway_seat": false,
        "seat_uid": null
    }
]'

Responses

🟢200Update a user seat response

application/json

Body

result

required

Any of

allOf {2}

array[object (seats) {5}]

allOf {2}

One of

array[object (seats) {5}]

object

access_seat

boolean

access_seat

optional

True if the seat is part of Access.

Example:

false

created_at

string <date-time>

timestamp

read-onlyoptional

Example:

2014-01-01T05:20:00.12345Z

gateway_seat

boolean

gateway_seat

optional

True if the seat is part of Gateway.

Example:

false

seat_uid

optional

The unique API identifier for the Zero Trust seat.

updated_at

string <date-time>

timestamp

read-onlyoptional

Example:

2014-01-01T05:20:00.12345Z

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

result_info

object

result_info

optional

count

number

optional

Total number of results for the requested service

Example:

page

number

optional

Current page within paginated list of results

Example:

per_page

number

optional

Number of results per page of results

Example:

total_count

number

optional

Total results available without any search parameters

Example:

2000

Example

{
    "errors": [],
    "messages": [],
    "result": [
        {
            "access_seat": false,
            "created_at": "2014-01-01T05:20:00.12345Z",
            "gateway_seat": false,
            "seat_uid": null,
            "updated_at": "2014-01-01T05:20:00.12345Z"
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

🟢200Update a user seat response failure

Modified at 2022-12-16 13:48:36

Revoke all Access tokens for a user

Get users