Skip to content

Commit

Permalink
Update README for the token types
Browse files Browse the repository at this point in the history
  • Loading branch information
ilijamt committed Dec 16, 2024
1 parent 889abbe commit 588f5c1
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,10 +111,38 @@ The current authentication model requires providing Vault with a Gitlab Token.
#### path
##### `token_type` is `personal`
Format of the path is `{username}` example `admin`.
##### `token_type` is `project`
Format of the path is the full path of the project for example `group/project` or `group/subgroup/project`
##### `token_type` is `group`
Format of the path is the full path of the project for example `group` or `group/subgroup`
##### `token_type` is `user-service-account`
Format of the path is `{username}` example `service_account_65c74d39b4f71fc3fdc72330fce28c28`.
##### `token_type` is `group-service-account`
Format of the path is `{groupId}/{serviceAccountName}` example `265/service_account_65c74d39b4f71fc3fdc72330fce28c28`.
##### `token_type` is `project-deploy`
Format of the path is the full path of the project for example `group/project` or `group/subgroup/project`
##### `token_type` is `group-deploy`
Format of the path is the full path of the project for example `group` or `group/subgroup`
##### `token_type` is `pipeline-project-trigger`
Format of the path is the full path of the project for example `group/project` or `group/subgroup/project`
#### name
When generating a token, you have control over the token's name by using templating. The name is constructed using Go's [text/template](https://pkg.go.dev/text/template), which allows for dynamic generation of names based on available data. You can refer to Go's [text/template](https://pkg.go.dev/text/template#hdr-Examples) documentation for examples and guidance on how to use it effectively.
Expand Down

0 comments on commit 588f5c1

Please sign in to comment.