From 4c7c2ab22d0541f6734e0927b7eb7bceb00f017d Mon Sep 17 00:00:00 2001 From: Jdubbs <702leopold@gmail.com> Date: Thu, 25 Jan 2024 11:38:15 +0200 Subject: [PATCH] created page for explanation of "jf access-token-create" command --- .../jfrog-cli/create-access-token.md | 40 +++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 jfrog-applications/jfrog-cli/create-access-token.md diff --git a/jfrog-applications/jfrog-cli/create-access-token.md b/jfrog-applications/jfrog-cli/create-access-token.md new file mode 100644 index 0000000..62d622a --- /dev/null +++ b/jfrog-applications/jfrog-cli/create-access-token.md @@ -0,0 +1,40 @@ +# Creating Access Tokens + +## Overview + +This page describes the usage of the `jf access-token-create` command. +The command allows creating [Access Tokens](https://jfrog.com/help/r/jfrog-rest-apis/access-tokens) for users in Artifactory via the Access service [REST API](https://jfrog.com/help/r/jfrog-rest-apis/access-tokens). + +**Note** + +> This command will require authentication with a valid access token. +It is possible to provide the token with each command, as shown in the example below, or to configure your server once by adding the `--access-token` option in the `jf c add / edit` command. You can find the `jf c add / edit` command +in the [JFrog Platform Configuration](https://docs.jfrog-applications.jfrog.io/jfrog-applications/jfrog-cli/configurations/jfrog-platform-configuration) page. +*** + +#### Commands Params + +| | | +| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Command name | access-token-create | +| Abbreviation | atc | +| Command options | | +| --access-token |

[Optional]

JFrog access token.

| +| --audience |

[Optional]

A space-separated list of the other instances or services that should accept this token identified by their Service-IDs.

| +| --description |

[Optional]

Free text token description. Useful for filtering and managing tokens. Limited to 1024 characters.

+| --expiry |

[Optional]

The amount of time, in seconds, it would take for the token to expire. Must be non-negative. If not provided, the platform default (1 year) will be used. To specify a token that never expires, set to zero. Non-admin may only set a value that is equal to or lower than the platform default that was set by an administrator.

| +| --grant-admin |

[Default: false]

Set to true to provide admin privileges to the access token. This is only available for administrators.

| +| --groups |

[Optional]

A list of comma-separated groups for the access token to be associated with. This is only available for administrators.

| +| --reference |

[Default: false]

Set to true to generate a Reference Token (alias to Access Token) in addition to the full token (available from Artifactory 7.38.10)

+| --refreshable |

[Default: false]

Set to true if you'd like the token to be refreshable. A refresh token will also be returned in order to be used to generate a new token once it expires.

| +| --scope |

[Optional]

The scope of access that the token provides. This is only available for administrators.

| +| Command arguments | | +| username | Optional - The user name for which this token is created. If not specified, the configured user is used. | + +#### Example + +Create an access token for username **commander-will-riker**. + +``` +jf atc commander-will-riker --scope=applied-permissions/groups:readers,riker-group --reference=true --expiry=31556952 --description="Token for Riker-group. Owner topdog@riker.com" +``` \ No newline at end of file