Skip to content

authentication-azureKeyVault

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

unset| set| rm| add| show|

unset authentication azureKeyVault

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

Synopsis

unset authentication azureKeyVault [-signatureAlg] [-pushService] [-defaultAuthenticationGroup] [-refreshInterval] [-authentication]

set authentication azureKeyVault

Modifies the specified attributes of an Azure key vault.

Synopsis

set authentication azureKeyVault [-vaultName ] [-clientID ] [-clientSecret ] [-serviceKeyName ] [-signatureAlg RS256] [-tokenEndpoint ] [-pushService ] [-defaultAuthenticationGroup ] [-refreshInterval ] [-tenantID ] [-authentication ( ENABLED | DISABLED )]

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 Citrix ADC 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.

authentication If authentication is disabled, otp checks are not performed after azure vault keys are obtained. This is useful to distinguish whether user has registered devices.

Possible values: ENABLED, DISABLED Default value: ENABLED

rm authentication azureKeyVault

Deletes an existing Azure key vault.

Synopsis

rm authentication azureKeyVault

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 Citrix ADC 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').

add authentication azureKeyVault

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

Synopsis

add authentication azureKeyVault -vaultName -clientID -clientSecret -serviceKeyName [-signatureAlg RS256] [-tokenEndpoint ] [-pushService ] [-defaultAuthenticationGroup ] [-refreshInterval ] [-tenantID ] [-authentication ( ENABLED | DISABLED )]

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 Citrix ADC 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.

authentication If authentication is disabled, otp checks are not performed after azure vault keys are obtained. This is useful to distinguish whether user has registered devices.

Possible values: ENABLED, DISABLED Default value: ENABLED

show authentication azureKeyVault

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

Synopsis

show authentication azureKeyVault []

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 Citrix ADC 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').

Output

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.

authentication If authentication is disabled, otp checks are not performed after azure vault keys are obtained. This is useful to distinguish whether user has registered devices.

devno count stateflag

Was this article helpful?