Skip to content

Commit e2d48c4

Browse files
weltekialexellis
authored andcommitted
Rename Auth0 example -> IAM example
Signed-off-by: Han Verstraete (OpenFaaS Ltd) <[email protected]>
1 parent 614a8d6 commit e2d48c4

File tree

3 files changed

+10
-6
lines changed

3 files changed

+10
-6
lines changed

docs/openfaas-pro/iam/example-auth0.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1-
# Auth0 Example for OpenFaaS IAM
1+
# Example for OpenFaaS IAM
22

3-
In order to access the OpenFaaS API, a JWT Issuer must first be registered with the system.
3+
In order to access the OpenFaaS API, a JWT Issuer must first be registered with the system. In this example we will be using Auth0 as the identity provider for OpenFaaS.
44

55
Create an application on Auth0 for the OpenFaaS gateway, you'll need to obtain the corresponding "client_id".
66

7-
## Register the Issuer for Auth0
7+
> For more details on how to register different providers see: [Single Sign-On (SSO) for the OpenFaaS](/openfaas-pro/sso/overview/)
8+
9+
## Register the Issuer
810

911
An Issuer for `https://alexellis.eu.auth0.com/` might look like this:
1012

@@ -55,7 +57,7 @@ The principal field is optional, however if it is given, both the principal and
5557

5658
### Match on group membership
5759

58-
If you configure Auth0 to emit a "group" claim such as "openfaas-dev", you could match this with a condition, instead of specifying individual "sub" fields.
60+
If you configure your identity provider to emit a "group" claim such as "openfaas-dev", you could match this with a condition, instead of specifying individual "sub" fields.
5961

6062
Groups are often represented as a list in the JWT so the `ForAnyValue` set operator can be used for this:
6163

@@ -129,6 +131,8 @@ spec:
129131

130132
The JwtIssuer, Role and Policy resources are Kubernetes Custom Resources, and must be created within the `openfaas` namespace.
131133

134+
See [Permissions](/openfaas-pro/iam/overview/#permissions) for an overview of all supported actions.
135+
132136
## Authenticate as the user
133137

134138
The `faas-cli` needs to be used to obtain a token from Auth0, and then exchange it for an OpenFaaS Access token.

docs/openfaas-pro/iam/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ OpenFaaS IAM objects are defined in the `openfaas` namespace, and need to be cre
111111

112112
## Examples
113113

114-
* [User authentication and IAM with Auth0](/openfaas-pro/iam/example-auth0)
114+
* [Create Roles and Policies](/openfaas-pro/iam/example-auth0)
115115

116116
### Web Identity Federation
117117

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ nav:
144144
- Retries: ./openfaas-pro/retries.md
145145
- IAM & Policy:
146146
- Overview: ./openfaas-pro/iam/overview.md
147-
- Auth0 Example: ./openfaas-pro/iam/example-auth0.md
147+
- IAM Example: ./openfaas-pro/iam/example-auth0.md
148148
- GitHub Actions Federation: ./openfaas-pro/iam/github-actions-federation.md
149149
- GitLab Federation: ./openfaas-pro/iam/gitlab-federation.md
150150
- Auditing Events: ./openfaas-pro/iam/auditing.md

0 commit comments

Comments
 (0)