home.md

OpenID Connect Keycloak SSO Integration

Namespace: \

Functions

oidc_keycloak_add_default_role_setting() : \array<mixed>

 oidc_keycloak_add_default_role_setting(\array<mixed>  $fields) : \array<mixed>

Summary

Adds a new setting that allows configuration of the default role assigned to users when no IDP role is provided.

Details:

• File: oidc-keycloak-custom.php
• See Also:
• https://github.com/daggerhart/openid-connect-generic#openid-connect-generic-settings-fields

Parameters:

Type	Name	Description
\array	$fields	The array of settings fields.

Returns: \array

Tags

Tag	Version	Description
package		OpenidConnectGeneric_MuPlugin

oidc_keycloak_add_login_button_text_setting() : \array<mixed>

 oidc_keycloak_add_login_button_text_setting(\array<mixed>  $fields) : \array<mixed>

Summary

Adds a new setting that allows an Administrator to set the button text from the plugin settings screen.

Details:

• File: oidc-keycloak-custom.php
• See Also:
• https://github.com/daggerhart/openid-connect-generic#openid-connect-generic-settings-fields

Parameters:

Type	Name	Description
\array	$fields	The array of settings fields.

Returns: \array

Tags

Tag	Version	Description
package		OpenidConnectGeneric_MuPlugin

oidc_keycloak_add_require_idp_role_setting() : \array<mixed>

 oidc_keycloak_add_require_idp_role_setting(\array<mixed>  $fields) : \array<mixed>

Summary

Setting to indicate whether an IDP role mapping is required for user creation.

Details:

• File: oidc-keycloak-custom.php
• See Also:
• https://github.com/daggerhart/openid-connect-generic#openid-connect-generic-settings-fields

Parameters:

Type	Name	Description
\array	$fields	The array of settings fields.

Returns: \array

Tags

Tag	Version	Description
package		OpenidConnectGeneric_MuPlugin

oidc_keycloak_login_button_text() : string

 oidc_keycloak_login_button_text(string  $text) : string

Summary

Modifies the OIDC login button text.

Details:

• File: oidc-keycloak-custom.php
• See Also:
• https://github.com/daggerhart/openid-connect-generic#openid-connect-generic-login-button-text

Parameters:

Type	Name	Description
string	$text	The button text.

Returns: string

Tags

Tag	Version	Description
package		OpenidConnectGeneric_MuPlugin

oidc_keycloak_map_user_role() : void

 oidc_keycloak_map_user_role(\WP_User  $user, \array<mixed>  $user_claim) : void

Summary

Set user role on based on IDP role after authentication.

Details:

• File: oidc-keycloak-custom.php

Parameters:

Type	Name	Description
\WP_User	$user	The authenticated user's WP_User object.
\array	$user_claim	The IDP provided Identity Token user claim array.

Returns: void

Tags

Tag	Version	Description
package		OpenidConnectGeneric_MuPlugin

oidc_keycloak_role_mapping_setting() : \array<mixed>

 oidc_keycloak_role_mapping_setting(\array<mixed>  $fields) : \array<mixed>

Summary

Adds new settings that allows mapping IDP roles to WordPress roles.

Details:

• File: oidc-keycloak-custom.php
• See Also:
• https://github.com/daggerhart/openid-connect-generic#openid-connect-generic-settings-fields

Parameters:

Type	Name	Description
\array	$fields	The array of settings fields.

Returns: \array

Tags

Tag	Version	Description
package		OpenidConnectGeneric_MuPlugin

oidc_keycloak_user_creation_test() : boolean

 oidc_keycloak_user_creation_test(boolean  $result, \array<mixed>  $user_claim) : boolean

Summary

Determine whether user should be created using plugin settings & IDP identity.

Details:

• File: oidc-keycloak-custom.php

Parameters:

Type	Name	Description
boolean	$result	The plugin user creation test flag.
\array	$user_claim	The authenticated user's IDP Identity Token user claim.

Returns: boolean

Tags

Tag	Version	Description
package		OpenidConnectGeneric_MuPlugin

---

Reports

• Errors - 0
• Markers - 0
• Deprecated - 0

---

This document was automatically generated from source code comments on 2020-08-24 using phpDocumentor and fr3nch13/phpdoc-markdown