Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: excerpts exchanged to to content division

The KEYCLOAKOAUTH policy is used to secure an API via any other identity provider. Since every Scheer PAS installation contains a Keycloak instance, and Keycloak supports a lot of different providers, this Keycloak-specific OAuth2 policy should be your first choice to secure an API in the PAS environment.

Adding the Keycloak OAuth Policy

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNameattaching_a_policy
PageWithExcerptINTERNAL:_api_excerpts

In a PAS setup, you can use the policy defaults:

  • The Realm name is set automatically.
  • Leave Keycloak Realm Certificate empty. The policy will try to fetch the public keys directly from your Keycloak realm.
  • In addition, we recommend to enable option Forward Roles (Forward Realm Roles). This simplifies the subsequent use of additional authorization with the AUTHORIZATION policy (refer to Additional Authorization for details).

Tip

Refer to KEYCLOAKOAUTH for a detailed overview on all settings of this policy.

Working with Keycloak Tokens

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamekeycloak_tokens
PageWithExcerptINTERNAL:_api_excerpts

How to Get the Secret

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamekeycloak_tokens_get_secret
PageWithExcerptINTERNAL:_api_excerpts_big

How to Retrieve the Keycloak Token

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamekeycloak_tokens_retrieve_token
PageWithExcerptINTERNAL:_api_excerpts_big

How to Use the Token for a Request

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamekeycloak_tokens_usage
PageWithExcerptINTERNAL:_api_excerpts


Panel
titleOn this Page:

Table of Contents


Panel
titleRelated Pages: