authentication pushService¶
The following operations can be performed on "authentication pushService":
add authentication pushService¶
Add a new push service entity on the Citrix ADC. The Push service will be configured with well known pre-defined default values for Namespace (https://mfa.cloud.com/) and Trust Service (https://trust.citrixworkspacesapi.net/) endpoints
Synopsys¶
add authentication pushService <name> [-clientID <string>] [-clientSecret ] [-CustomerID <string>] [-refreshInterval <positive_integer>]
Arguments¶
name
Name for the push service. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at sign (@), equal sign (=), and hyphen (-) characters. Cannot be changed after the profile is created.
CLI Users: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my push service" or 'my push service').
clientID
Unique identity for communicating with Citrix Push server in cloud.
clientSecret
Unique secret for communicating with Citrix Push server in cloud.
CustomerID
Customer id/name of the account in cloud that is used to create clientid/secret pair.
refreshInterval
Interval at which certificates or idtoken is refreshed.
Minimum value: 0
Example¶
add authentication pushservice <name> -clientid <> -clientsecret <> -customerid <>
rm authentication pushService¶
Remove a push service entity on the Citrix ADC
Synopsys¶
rm authentication pushService <name>
Arguments¶
name
Name of the push service
Example¶
rm authentication pushservice <name>
set authentication pushService¶
Set/modify push service entity values
Synopsys¶
set authentication pushService <name> [-clientID <string>] [-clientSecret ] [-CustomerID <string>] [-refreshInterval <positive_integer>]
Arguments¶
name
Name for the push service. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at sign (@), equal sign (=), and hyphen (-) characters. Cannot be changed after the profile is created.
CLI Users: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my push service" or 'my push service').
clientID
Unique identity for communicating with Citrix Push server in cloud.
clientSecret
Unique secret for communicating with Citrix Push server in cloud.
CustomerID
Customer id/name of the account in cloud that is used to create clientid/secret pair.
refreshInterval
Interval at which certificates or idtoken is refreshed.
Default value: 50
Minimum value: 0
Example¶
set authentication pushservice <profile name> -clientid <>
unset authentication pushService¶
Use this command to remove authentication pushService settings.Refer to the set authentication pushService command for meanings of the arguments.
Synopsys¶
unset authentication pushService <name> -refreshInterval
show authentication pushService¶
Displays all the configured push service entities in the system. If a name is specified, then only that entity is shown.
Synopsys¶
show authentication pushService [<name>]
Arguments¶
name
Name of the push service entity.
Outputs¶
namespace
This is fully qualified domain name of the notification service in the cloud. If omitted, namespace defaults to https://mfa.cloud.com/
hubName
Name of the hub within a namespace. This is used to classify different identities within a namespace.
serviceKey
Key to be used to compute signature necessary for registering to notification service.
serviceKeyName
Friendly name of the Key to be used to compute signature necessary for registering to notification service.
clientID
Unique identity for communicating with Citrix Push server in cloud.
clientSecret
Unique secret for communicating with Citrix Push server in cloud.
CustomerID
Customer id/name of the account in cloud that is used to create clientid/secret pair.
CertEndpoint
URL of the endpoint that contains JWKs (Json Web Key) for JWT (Json Web Token) verification. This is used at cloud instance that offers push service.
refreshInterval
Interval at which certificates or idtoken is refreshed.
stateflag
State flag
pushServiceStatus
Describes status of push service.
trustService
URL of the service that generates tokens for cloud access.
pushCloudServerStatus
Describes status of the cloud service that does push.
signingKeyName
Friendly name of the Key to be used to compute signature necessary for accessing notification service.
signingKey
Key to be used to compute signature necessary for accessing notification service.
devno
count
Example¶
show authentication pushservice [name]