AuthMappingRule

AuthMappingRule

JSON Example

{
    "assign_policy": "string",
    "assign_role": "string",
    "assign_tenant": "string",
    "assign_userprofile": "string",
    "attribute_match": {
        "criteria": "string",
        "name": "string",
        "values": [
            "string"
        ]
    },
    "default_tenant_ref": "string",
    "group_match": {
        "criteria": "string",
        "groups": [
            "string"
        ]
    },
    "index": 0,
    "is_superuser": false,
    "policy_attribute_name": "string",
    "role_attribute_name": "string",
    "role_refs": [
        "string"
    ],
    "tenant_attribute_name": "string",
    "tenant_refs": [
        "string"
    ],
    "userprofile_attribute_name": "string",
    "userprofile_ref": "string"
}

string

assign_policy

Optional

Assignment rule for the Object Access Policy. Enum options - ASSIGN_ALL, ASSIGN_FROM_SELECT_LIST, ASSIGN_MATCHING_GROUP_NAME, ASSIGN_MATCHING_ATTRIBUTE_VALUE, ASSIGN_MATCHING_GROUP_REGEX, ASSIGN_MATCHING_ATTRIBUTE_REGEX, ASSIGN_CONFIG_CONTAINS_ATTRIBUTE_VALUE. Field introduced in 18.2.7, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

assign_role

Optional

Enum options - ASSIGN_ALL, ASSIGN_FROM_SELECT_LIST, ASSIGN_MATCHING_GROUP_NAME, ASSIGN_MATCHING_ATTRIBUTE_VALUE, ASSIGN_MATCHING_GROUP_REGEX, ASSIGN_MATCHING_ATTRIBUTE_REGEX, ASSIGN_CONFIG_CONTAINS_ATTRIBUTE_VALUE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

assign_tenant

Optional

Enum options - ASSIGN_ALL, ASSIGN_FROM_SELECT_LIST, ASSIGN_MATCHING_GROUP_NAME, ASSIGN_MATCHING_ATTRIBUTE_VALUE, ASSIGN_MATCHING_GROUP_REGEX, ASSIGN_MATCHING_ATTRIBUTE_REGEX, ASSIGN_CONFIG_CONTAINS_ATTRIBUTE_VALUE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

assign_userprofile

Optional

Assignment rule for the User Account Profile. Enum options - ASSIGN_ALL, ASSIGN_FROM_SELECT_LIST, ASSIGN_MATCHING_GROUP_NAME, ASSIGN_MATCHING_ATTRIBUTE_VALUE, ASSIGN_MATCHING_GROUP_REGEX, ASSIGN_MATCHING_ATTRIBUTE_REGEX, ASSIGN_CONFIG_CONTAINS_ATTRIBUTE_VALUE. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

AuthMatchAttribute

attribute_match

Optional

attribute_match

string

default_tenant_ref

Optional

Default tenant ref to assign to user. It is a reference to an object of type Tenant. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

AuthMatchGroupMembership

group_match

Optional

group_match

integer As int32 As int32

index

Required

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean

is_superuser

Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

policy_attribute_name

Optional

Attribute name for Object Access Policy assignment. Field introduced in 18.2.7, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

role_attribute_name

Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of string

role_refs

Optional

It is a reference to an object of type Role. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

tenant_attribute_name

Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of string

tenant_refs

Optional

It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

userprofile_attribute_name

Optional

Attribute name for User Account Profile assignment. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string

userprofile_ref

Optional

User Account Profile to assign to user on successful match. It is a reference to an object of type UserAccountProfile. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

Property Of

AlternateAuthConfiguration

AuthMappingProfile