Skip to content

Commit

Permalink
chore: Add usage description for SSC token commands
Browse files Browse the repository at this point in the history
  • Loading branch information
rsenden committed Oct 23, 2023
1 parent 14a7882 commit f259d41
Showing 1 changed file with 10 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -142,21 +142,31 @@ fcli.ssc.access-control.role.name = Role name.
fcli.ssc.access-control.get-permission.usage.header = Get permission details.
fcli.ssc.access-control.list-permissions.usage.header = List permissions.
fcli.ssc.access-control.permission.resolver.nameOrId = Permission name or id.
# Re-usable command description for token commands.
fcli.ssc.access-control.token.usage.description = This command can be used either with an existing SSC session \
(re-using SSC URL and other SSC connection settings), or without an existing session (in which case you'll \
need to provide the SSC URL and any other relevant connection settings). SSC always requires user name and \
password to be specified for token operations, hence you'll need to provide these even if you already \
established an SSC session.
fcli.ssc.access-control.create-token.usage.header = Create a token.
fcli.ssc.access-control.create-token.usage.description = ${fcli.ssc.access-control.token.usage.description}
fcli.ssc.access-control.create-token.expire-in = Expire token after the given time period, which is specified as \
30m (30 minutes), 2h (2 hours), 1d (1 day).
fcli.ssc.access-control.create-token.description = Token description.
fcli.ssc.access-control.create-token.type = Token type, like CIToken, AnalysisUploadToken, ...
fcli.ssc.access-control.create-token.connect-timeout = Connection timeout for this command, for example 30s (30 seconds), 5m (5 minutes). Default value: ${default-connect-timeout}.
fcli.ssc.access-control.create-token.socket-timeout = Socket timeout for this command, for example 30s (30 seconds), 5m (5 minutes). Default value: ${default-socket-timeout}.
fcli.ssc.access-control.list-tokens.usage.header = List tokens.
fcli.ssc.access-control.list-tokens.usage.description = ${fcli.ssc.access-control.token.usage.description}
fcli.ssc.access-control.list-tokens.connect-timeout = Connection timeout for this command, for example 30s (30 seconds), 5m (5 minutes). Default value: ${default-connect-timeout}.
fcli.ssc.access-control.list-tokens.socket-timeout = Socket timeout for this command, for example 30s (30 seconds), 5m (5 minutes). Default value: ${default-socket-timeout}.
fcli.ssc.access-control.revoke-token.usage.header = Revoke a token.
fcli.ssc.access-control.revoke-token.usage.description = ${fcli.ssc.access-control.token.usage.description}
fcli.ssc.access-control.revoke-token.idsOrValues = Either one or more token id's, or one or more token values (comma-separated)
fcli.ssc.access-control.revoke-token.connect-timeout = Connection timeout for this command, for example 30s (30 seconds), 5m (5 minutes). Default value: ${default-connect-timeout}.
fcli.ssc.access-control.revoke-token.socket-timeout = Socket timeout for this command, for example 30s (30 seconds), 5m (5 minutes). Default value: ${default-socket-timeout}.
fcli.ssc.access-control.update-token.usage.header = Update a token.
fcli.ssc.access-control.update-token.usage.description = ${fcli.ssc.access-control.token.usage.description}
fcli.ssc.access-control.update-token.token-id = Token id as shown by token create and list commands. Note that this \
command does not accept the actual token value.
fcli.ssc.access-control.update-token.expire-in = Update token expiration period, specified as 30m (30 minutes), \
Expand Down

0 comments on commit f259d41

Please sign in to comment.