From 5a0e100e9c0f6904bb7251f72d059b3a1f98efe2 Mon Sep 17 00:00:00 2001 From: Jack Halford Date: Mon, 17 May 2021 16:48:09 +0000 Subject: [PATCH 1/2] backport of commit aef7da306dec0b244bc062d66ef9d0965fae4dc8 --- 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..0c95b2b4e731 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. + 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: )` - ID of the entity alias. If set, updates the corresponding entity alias. From f0d2e7dc802473458f6c25cb8d5e640e993fec2a Mon Sep 17 00:00:00 2001 From: Jack Halford Date: Tue, 15 Jun 2021 16:30:21 +0000 Subject: [PATCH 2/2] backport of commit cf08ac691da9c0317f009ccccfe4e76f79854318 --- website/content/api-docs/secret/identity/entity-alias.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/content/api-docs/secret/identity/entity-alias.mdx b/website/content/api-docs/secret/identity/entity-alias.mdx index 0c95b2b4e731..f8ee39a6bd75 100644 --- a/website/content/api-docs/secret/identity/entity-alias.mdx +++ b/website/content/api-docs/secret/identity/entity-alias.mdx @@ -30,8 +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. If alias - belongs to an approle backend, the name should be a valid role_id. + 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.