diff --git a/docs/extend/extend-apiml/api-mediation-oidc-authentication.md b/docs/extend/extend-apiml/api-mediation-oidc-authentication.md index 3a6be271f0..33f193f57e 100644 --- a/docs/extend/extend-apiml/api-mediation-oidc-authentication.md +++ b/docs/extend/extend-apiml/api-mediation-oidc-authentication.md @@ -85,56 +85,6 @@ Ensure that the following prerequisites are met: - Client application users have their distributed identity managed by the OIDC provider. For details, see the section [OIDC provider](#oidc-provider-prerequisites) in this topic. - SAF/ESM is configured with mapping between the mainframe and distributed user identities. For details, see the section [ESM configuration](#esm-configuration-prerequisites) in this topic. -### OIDC provider prerequisites - -The Gateway service can be configured to provide OIDC client functionality and initiate OIDC authentication flow to obtain an access token. Provide the following configuration in your zowe.yaml file: - -```yaml -components: - gateway: - spring: - security: - oauth2: - client: - registration: - : - issuer: - clientId: - clientSecret: - provider: - : - authorizationUri: /v1/authorize - tokenUri: /v1/token - userInfoUri: /v1/userinfo - userNameAttribute: sub - jwkSetUri: /v1/keys - - -``` -- **provider-id** - The ID of the Identity provider. Currently supported options are `okta` and `entra`. -- **components.gateway.spring.security.oauth2.client.registration.\.issuer** - The URL of the Token issuer. - Example: `https://dev-okta.com/oauth2`. -- **components.gateway.spring.security.oauth2.client.registration.\.clientId** - The Client application ID. -- **components.gateway.spring.security.oauth2.client.registration.\.clientSecret** - The Client application secret. -- **components.gateway.spring.security.oauth2.client.provider.\.authorizationUri** - The URL for the authorization request. -- **components.gateway.spring.security.oauth2.client.provider.\.tokenUri** - The URL to obtain the token. -- **components.gateway.spring.security.oauth2.client.provider.\.userInfoUri** - The URL to retrieve user information. -- **components.gateway.spring.security.oauth2.client.provider.\.userNameAttribute** - The JWT attribute to locate the user ID. -- **components.gateway.spring.security.oauth2.client.provider.\.jwkSetUri** - The URL to retrieve the JSON Web Key Set. - - - :::tip - Consult your OIDC provider documentation for options and requirements available for your type of client application. - ::: ### ESM configuration prerequisites @@ -219,6 +169,59 @@ For details about how to use the plug-in tool to set up mapping in the ESM of yo ## API ML OIDC configuration +### OIDC client configuration + +The Gateway service can be configured to provide OIDC client functionality and initiate OIDC authentication flow to obtain an access token. Provide the following configuration in your zowe.yaml file: + +```yaml +components: + gateway: + spring: + security: + oauth2: + client: + registration: + : + issuer: + clientId: + clientSecret: + provider: + : + authorizationUri: /v1/authorize + tokenUri: /v1/token + userInfoUri: /v1/userinfo + userNameAttribute: sub + jwkSetUri: /v1/keys + + +``` +- **provider-id** + The ID of the Identity provider. Currently supported options are `okta` and `entra`. +- **components.gateway.spring.security.oauth2.client.registration.\.issuer** + The URL of the Token issuer. + Example: `https://dev-okta.com/oauth2`. +- **components.gateway.spring.security.oauth2.client.registration.\.clientId** + The Client application ID. +- **components.gateway.spring.security.oauth2.client.registration.\.clientSecret** + The Client application secret. +- **components.gateway.spring.security.oauth2.client.provider.\.authorizationUri** + The URL for the authorization request. +- **components.gateway.spring.security.oauth2.client.provider.\.tokenUri** + The URL to obtain the token. +- **components.gateway.spring.security.oauth2.client.provider.\.userInfoUri** + The URL to retrieve user information. +- **components.gateway.spring.security.oauth2.client.provider.\.userNameAttribute** + The JWT attribute to locate the user ID. +- **components.gateway.spring.security.oauth2.client.provider.\.jwkSetUri** + The URL to retrieve the JSON Web Key Set. + + +:::tip +Consult your OIDC provider documentation for options and requirements available for your type of client application. +::: + +### OIDC resource server configuration + Use the following procedure to enable the feature to use an OIDC Access Token as the method of authentication for the API Mediation Layer Gateway. :::tip