Skip to content

Commit

Permalink
Update entity-alias.mdx
Browse files Browse the repository at this point in the history
it was not clear for approle what the name should be the approle name or the role_id.
  • Loading branch information
jzck committed Aug 20, 2021
1 parent 7212475 commit aef7da3
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 @@ -19,7 +19,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.
backend. If alias belongs to GitHub, it should be the GitHub username. If alias
belongs to an approle backend, the name should be a valid role_id.

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

0 comments on commit aef7da3

Please sign in to comment.