Skip to content

Commit

Permalink
Update entity-alias.mdx (#11629)
Browse files Browse the repository at this point in the history
* Update entity-alias.mdx

it was not clear for approle what the name should be the approle name or the role_id.

* Update website/content/api-docs/secret/identity/entity-alias.mdx

Co-authored-by: Yoko Hyakuna <[email protected]>

Co-authored-by: Yoko Hyakuna <[email protected]>
  • Loading branch information
jzck and yhyakuna authored Dec 20, 2021
1 parent ab8807d commit 44dadee
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion website/content/api-docs/secret/identity/entity-alias.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@ This endpoint creates a new alias for an entity.
- `name` `(string: <required>)` - Name of the alias. Name should be the identifier
of the client in the authentication source. For example, if the alias belongs
to userpass backend, the name should be a valid username within userpass
backend. If alias belongs to GitHub, it should be the GitHub username.
auth method. If the alias belongs to GitHub, it should be the GitHub username. If the alias
belongs to an approle auth method, the name should be a valid RoleID.

- `id` `(string: <optional>)` - ID of the entity alias. If set, updates the
corresponding entity alias.
Expand Down

0 comments on commit 44dadee

Please sign in to comment.