AuthProfile

AuthProfile
AuthProfile
JSON Example 
{
    "_last_modified": "string",
    "configpb_attributes": {
        "version": 0
    },
    "description": "string",
    "http": {
        "cache_expiration_time": 0,
        "request_header": "string",
        "require_user_groups": [
            "string"
        ]
    },
    "jwt_profile_ref": "string",
    "ldap": {
        "base_dn": "string",
        "bind_as_administrator": false,
        "email_attribute": "string",
        "full_name_attribute": "string",
        "port": 0,
        "security_mode": "string",
        "server": [
            "string"
        ],
        "settings": {
            "admin_bind_dn": "string",
            "group_filter": "string",
            "group_member_attribute": "string",
            "group_member_is_full_dn": false,
            "group_search_dn": "string",
            "group_search_scope": "string",
            "ignore_referrals": false,
            "password": "string",
            "user_attributes": [
                "string"
            ],
            "user_id_attribute": "string",
            "user_search_dn": "string",
            "user_search_scope": "string"
        },
        "user_bind": {
            "dn_template": "string",
            "token": "string",
            "user_attributes": [
                "string"
            ],
            "user_id_attribute": "string"
        }
    },
    "markers": [
        {
            "key": "string",
            "values": [
                "string"
            ]
        }
    ],
    "name": "string",
    "oauth_profile": {
        "authorization_endpoint": "string",
        "end_session_endpoint": "string",
        "instance_id": "string",
        "introspection_endpoint": "string",
        "issuer": "string",
        "jwks_timeout": 0,
        "jwks_uri": "string",
        "oauth_controller_settings": {
            "client_id": "string",
            "client_secret": "string",
            "oidc_config": {
                "oidc_enable": false,
                "profile": false,
                "userinfo": false
            },
            "scopes": [
                "string"
            ]
        },
        "oauth_profile_type": "string",
        "oauth_provider": "string",
        "oauth_resp_buffer_sz": 0,
        "org_id": "string",
        "pool_ref": "string",
        "redirect_uri": "string",
        "service_id": "string",
        "service_name": "string",
        "token_endpoint": "string",
        "userinfo_endpoint": "string"
    },
    "saml": {
        "idp": {
            "meta_data_download_interval": 0,
            "metadata": "string",
            "metadata_url": "string",
            "periodic_download": false
        },
        "sp": {
            "fqdn": "string",
            "org_display_name": "string",
            "org_name": "string",
            "org_url": "string",
            "saml_entity_type": "string",
            "sp_nodes": [
                {
                    "entity_id": "string",
                    "name": "string",
                    "signing_ssl_key_and_certificate_ref": "string",
                    "single_signon_url": "string"
                }
            ],
            "tech_contact_email": "string",
            "tech_contact_name": "string"
        }
    },
    "tacacs_plus": {
        "authorization_attrs": [
            {
                "mandatory": false,
                "name": "string",
                "value": "string"
            }
        ],
        "password": "string",
        "port": 0,
        "server": [
            "string"
        ],
        "service": "string"
    },
    "tenant_ref": "string",
    "type": "string",
    "url": "string",
    "uuid": "string"
}
string
_last_modified
Optional

UNIX time since epoch in microseconds. Units(MICROSECONDS).

ConfigPbAttributes
configpb_attributes
Optional

configpb_attributes

string
description
Optional

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

AuthProfileHTTPClientParams
http
Optional

http

string
jwt_profile_ref
Optional

JWTServerProfile to be used for authentication. It is a reference to an object of type JWTServerProfile. Field introduced in 20.1.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

LdapAuthSettings
ldap
Optional

ldap

array of RoleFilterMatchLabel
markers
Optional

List of labels to be used for granular RBAC. Field introduced in 20.1.6. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
name
Required

Name of the Auth Profile. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

OAuthProfile
oauth_profile
Optional

oauth_profile

SamlSettings
saml
Optional

saml

TacacsPlusAuthSettings
tacacs_plus
Optional

tacacs_plus

string
tenant_ref
Optional

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

string
type
Required

Type of the Auth Profile. Enum options - AUTH_PROFILE_LDAP, AUTH_PROFILE_TACACS_PLUS, AUTH_PROFILE_SAML, AUTH_PROFILE_PINGACCESS, AUTH_PROFILE_JWT, AUTH_PROFILE_OAUTH. Allowed with any value in Enterprise, Enterprise with Cloud Services edition. Allowed in Essentials (Allowed values- AUTH_PROFILE_LDAP,AUTH_PROFILE_TACACS_PLUS,AUTH_PROFILE_SAML,AUTH_PROFILE_JWT,AUTH_PROFILE_OAUTH), Basic (Allowed values- AUTH_PROFILE_LDAP,AUTH_PROFILE_TACACS_PLUS,AUTH_PROFILE_SAML,AUTH_PROFILE_JWT,AUTH_PROFILE_OAUTH) edition.

string
url
Optional

url

string
uuid
Optional

UUID of the Auth Profile. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

Property Of
Parameter To
Returned By