Create an Access group

POST /accounts/{account_id}/access/groups

Copy endpoint

https://api.cloudflare.com/client/v4

Creates a new Access group.

Parameters

Name	Type
`account_id` required	type AccessIdentifier = string

application/json required

{
exclude?:

AccessExclude

Rules evaluated with a NOT logical operator. To match a policy, a user cannot meet any of the Exclude rules.

type AccessExclude = AccessRule[]

;
include:

AccessInclude

Rules evaluated with an OR logical operator. A user needs to meet only one of the Include rules.

type AccessInclude = AccessRule[]

;
is_default?:

AccessIsDefault

Whether this is the default group

type AccessIsDefault = boolean

;
name:

AccessGroupsComponentsSchemasName

The name of the Access group.

type AccessGroupsComponentsSchemasName = string

;
require?:

AccessRequire

Rules evaluated with an AND logical operator. To match a policy, a user must meet all of the Require rules.

type AccessRequire = AccessRule[]

;
}

201 application/json

Create an Access group response

type AccessGroupsComponentsSchemasSingleResponse = never

4XX application/json

Create an Access group response failure

interface AccessApiResponseCommonFailure {
errors:

AccessMessages

type AccessMessages = {
code: number;
documentation_url?: string;
message: string;
source?: { pointer?: string; };
}[]

;
messages:

AccessMessages

type AccessMessages = {
code: number;
documentation_url?: string;
message: string;
source?: { pointer?: string; };
}[]

;
result: null;
success: false;
}