Download full document:

authentication azureKeyVault

The following operations can be performed on "authentication azureKeyVault":

add| rm| set| unset| show

add authentication azureKeyVault

p{white-space: pre-wrap;}

Creates a Azure key vault profile. This profile is used to interact with azure services for data signature and storage.

Synopsys

add authentication azureKeyVault <name> -vaultName <string> -clientID <string> -clientSecret -serviceKeyName <string> [-signatureAlg RS256] [-tokenEndpoint <URL>] [-pushService <string>] [-defaultAuthenticationGroup <string>] [-refreshInterval <positive_integer>] [-tenantID <string>]

Arguments

name

Name for the new Azure Key Vault profile. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after an action is created.

The following requirement applies only to the NetScaler CLI:

If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my action" or 'my action').

vaultName

Name of the Azure vault account as configured in azure portal.

clientID

Unique identity of the relying party requesting for authentication.

clientSecret

Unique secret string to authorize relying party at authorization server.

serviceKeyName

Friendly name of the Key to be used to compute signature.

signatureAlg

Algorithm to be used to sign/verify transactions

Possible values: RS256

Default value: RS256

tokenEndpoint

URL endpoint on relying party to which the OAuth token is to be sent.

pushService

Name of the service used to send push notifications

defaultAuthenticationGroup

This is the group that is added to user sessions that match current IdP policy. It can be used in policies to identify relying party trust.

refreshInterval

Interval at which access token in obtained.

Default value: 50

Minimum value: 0

tenantID

TenantID of the application. This is usually specific to providers such as Microsoft and usually refers to the deployment identifier.

rm authentication azureKeyVault

p{white-space: pre-wrap;}

Deletes an existing Azure key vault.

Synopsys

rm authentication azureKeyVault <name>

Arguments

name

Name for the new Azure Key Vault profile. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after an action is created.

The following requirement applies only to the NetScaler CLI:

If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my action" or 'my action').

set authentication azureKeyVault

p{white-space: pre-wrap;}

Modifies the specified attributes of an Azure key vault.

Synopsys

set authentication azureKeyVault <name> [-vaultName <string>] [-clientID <string>] [-clientSecret ] [-serviceKeyName <string>] [-signatureAlg RS256] [-tokenEndpoint <URL>] [-pushService <string>] [-defaultAuthenticationGroup <string>] [-refreshInterval <positive_integer>] [-tenantID <string>]

Arguments

name

Name for the new Azure Key Vault profile. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after an action is created.

The following requirement applies only to the NetScaler CLI:

If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my action" or 'my action').

vaultName

Name of the Azure vault account as configured in azure portal.

clientID

Unique identity of the relying party requesting for authentication.

clientSecret

Unique secret string to authorize relying party at authorization server.

serviceKeyName

Friendly name of the Key to be used to compute signature.

signatureAlg

Algorithm to be used to sign/verify transactions

Possible values: RS256

Default value: RS256

tokenEndpoint

URL endpoint on relying party to which the OAuth token is to be sent.

pushService

Name of the service used to send push notifications

defaultAuthenticationGroup

This is the group that is added to user sessions that match current IdP policy. It can be used in policies to identify relying party trust.

refreshInterval

Interval at which access token in obtained.

Default value: 50

Minimum value: 0

tenantID

TenantID of the application. This is usually specific to providers such as Microsoft and usually refers to the deployment identifier.

unset authentication azureKeyVault

p{white-space: pre-wrap;}

Use this command to remove authentication azureKeyVault settings.Refer to the set authentication azureKeyVault command for meanings of the arguments.

Synopsys

unset authentication azureKeyVault <name> [-signatureAlg] [-pushService] [-defaultAuthenticationGroup] [-refreshInterval]

show authentication azureKeyVault

p{white-space: pre-wrap;}

Displays information about all configured Azure key vaults, or displays detailed information about the specified vault.

Synopsys

show authentication azureKeyVault [<name>]

Arguments

name

Name for the new Azure Key Vault profile. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after an action is created.

The following requirement applies only to the NetScaler CLI:

If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my action" or 'my action').

Outputs

vaultName

Name of the Azure vault account as configured in azure portal.

clientID

Unique identity of the relying party requesting for authentication.

clientSecret

Unique secret string to authorize relying party at authorization server.

serviceKeyName

Friendly name of the Key to be used to compute signature.

signatureAlg

Algorithm to be used to sign/verify transactions

tokenEndpoint

URL endpoint on relying party to which the OAuth token is to be sent.

pushService

Name of the service used to send push notifications

defaultAuthenticationGroup

This is the group that is added to user sessions that match current IdP policy. It can be used in policies to identify relying party trust.

refreshInterval

Interval at which access token in obtained.

tenantID

TenantID of the application. This is usually specific to providers such as Microsoft and usually refers to the deployment identifier.

devno

count

stateflag