From 422508e6d9be9af1f00aabb959bab9fc0afdaded Mon Sep 17 00:00:00 2001 From: Jack Halford Date: Mon, 20 Dec 2021 21:05:34 +0100 Subject: [PATCH] Update entity-alias.mdx (#11629) * 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 Co-authored-by: Yoko Hyakuna --- website/content/api-docs/secret/identity/entity-alias.mdx | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/website/content/api-docs/secret/identity/entity-alias.mdx b/website/content/api-docs/secret/identity/entity-alias.mdx index 896b41e9c8c8..f8ee39a6bd75 100644 --- a/website/content/api-docs/secret/identity/entity-alias.mdx +++ b/website/content/api-docs/secret/identity/entity-alias.mdx @@ -30,7 +30,8 @@ This endpoint creates a new alias for an entity. - `name` `(string: )` - 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: )` - ID of the entity alias. If set, updates the corresponding entity alias.