Create an Access group

Creates a new Access group.

Request

Path Params

identifier

string

required

Body Params application/json

exclude

array[null (rule_components-schemas-rule) {12}]

optional

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

object

optional

Matches a specific email.

object

Email domain

optional

Match an entire email domain.

object

Everyone

optional

Matches everyone.

object

IP ranges

optional

Matches an IP address block.

object

IP list

optional

Matches an IP address from a list.

object

Valid certificate

optional

Matches any valid client certificate.

Example:

{"certificate":{}}

object

Access groups

optional

Matches an Access group.

object

Azure group

optional

Matches an Azure group.
Requires an Azure identity provider.

object

Github organization

optional

Matches a Github organization.
Requires a Github identity provider.

object

Google Workspace group

optional

Matches a group in Google Workspace.
Requires a Google Workspace identity provider.

object

Okta group

optional

Matches an Okta group.
Requires an Okta identity provider.

object

SAML group

optional

Matches a SAML group.
Requires a SAML identity provider.

include

array[null (rule_components-schemas-rule) {12}]

required

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

object

optional

Matches a specific email.

object

Email domain

optional

Match an entire email domain.

object

Everyone

optional

Matches everyone.

object

IP ranges

optional

Matches an IP address block.

object

IP list

optional

Matches an IP address from a list.

object

Valid certificate

optional

Matches any valid client certificate.

Example:

{"certificate":{}}

object

Access groups

optional

Matches an Access group.

object

Azure group

optional

Matches an Azure group.
Requires an Azure identity provider.

object

Github organization

optional

Matches a Github organization.
Requires a Github identity provider.

object

Google Workspace group

optional

Matches a group in Google Workspace.
Requires a Google Workspace identity provider.

object

Okta group

optional

Matches an Okta group.
Requires an Okta identity provider.

object

SAML group

optional

Matches a SAML group.
Requires a SAML identity provider.

name

string

required

The name of the Access group.

Example:

Allow devs

require

array[null (rule_components-schemas-rule) {12}]

optional

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

object

optional

Matches a specific email.

object

Email domain

optional

Match an entire email domain.

object

Everyone

optional

Matches everyone.

object

IP ranges

optional

Matches an IP address block.

object

IP list

optional

Matches an IP address from a list.

object

Valid certificate

optional

Matches any valid client certificate.

Example:

{"certificate":{}}

object

Access groups

optional

Matches an Access group.

object

Azure group

optional

Matches an Azure group.
Requires an Azure identity provider.

object

Github organization

optional

Matches a Github organization.
Requires a Github identity provider.

object

Google Workspace group

optional

Matches a group in Google Workspace.
Requires a Google Workspace identity provider.

object

Okta group

optional

Matches an Okta group.
Requires an Okta identity provider.

object

SAML group

optional

Matches a SAML group.
Requires a SAML identity provider.

Example

{
    "exclude": [
        {
            "email": {
                "email": "test@example.com"
            }
        }
    ],
    "include": [
        {
            "email": {
                "email": "test@example.com"
            }
        }
    ],
    "name": "Allow devs",
    "require": [
        {
            "email": {
                "email": "test@example.com"
            }
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Create an Access group response

application/json

Body

allOf {2}

optional

object (api-response-single)

optional

errors

array [object {2}]

messages

required

Example:

[]

messages

array [object {2}]

messages

required

Example:

[]

result

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

object

optional

result

object (schemas-groups)

optional

Example

{
    "errors": [],
    "messages": [],
    "result": {
        "created_at": "2014-01-01T05:20:00.12345Z",
        "exclude": [
            {
                "email": {
                    "email": "test@example.com"
                }
            }
        ],
        "id": null,
        "include": [
            {
                "email": {
                    "email": "test@example.com"
                }
            }
        ],
        "name": "Allow devs",
        "require": [
            {
                "email": {
                    "email": "test@example.com"
                }
            }
        ],
        "updated_at": "2014-01-01T05:20:00.12345Z"
    },
    "success": true
}

🟢200Create an Access group response failure