KosmoKrator

productivity

Keycloak Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the Keycloak KosmoKrator integration.

Lua Namespace

Agents call this integration through app.integrations.keycloak.*. Use lua_read_doc("integrations.keycloak") inside KosmoKrator to discover the same reference at runtime.

Call Lua from the Headless CLI

Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic Keycloak workflow without starting an interactive agent session.

Inline Lua call 
kosmo integrations:lua --eval 'dump(app.integrations.keycloak.delete_realm({}))' --json
Read Lua docs headlessly 
kosmo integrations:lua --eval 'print(docs.read("keycloak"))' --json
kosmo integrations:lua --eval 'print(docs.read("keycloak.delete_realm"))' --json

Workflow file

Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.

workflow.lua 
local keycloak = app.integrations.keycloak
local result = keycloak.delete_realm({})

dump(result)
Run the workflow 
kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json
Namespace note. integrations:lua exposes app.integrations.keycloak, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.keycloak.default.* or app.integrations.keycloak.work.* when you configured named credential accounts.

MCP-only Lua

If the script only needs configured MCP servers and does not need Keycloak, use the narrower mcp:lua command.

MCP Lua command 
# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json

Agent-Facing Lua Docs

This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.

Keycloak Lua Docs

Namespace: keycloak

Keycloak exposes the official Admin REST API for realm administration. Tools are generated one-to-one from the Keycloak OpenAPI document and keep the upstream path, query, header, and body shape explicit.

Configuration

Provide an admin bearer token in access_token and the Keycloak server root in base_url, for example https://keycloak.example.test. The connection test also asks for a realm because the Admin REST API is realm scoped.

Usage Notes

  • Most tools require realm; pass master or the tenant realm name explicitly.
  • Path parameters with hyphens in the upstream API use snake_case arguments, such as user_id for {user-id}.
  • Query parameters preserve Keycloak behavior but are exposed as snake_case arguments, such as brief_representation for briefRepresentation.
  • For create and update endpoints, pass body as an object matching the Keycloak representation schema documented for that endpoint.
  • Tool responses are parsed JSON when Keycloak returns JSON. Empty 204 responses return { success = true, status = 204 }.

Examples

local users = keycloak.keycloak_get_admin_realms_realm_users({
  realm = "master",
  username = "alice",
  exact = true,
  brief_representation = true,
})
local created = keycloak.keycloak_post_admin_realms_realm_users({
  realm = "master",
  body = {
    username = "agent-test-user",
    enabled = true,
    email = "[email protected]",
  },
})

Use fake domains and test users in examples and test fixtures. Do not put production realms, user emails, or tokens into committed docs.

Raw agent markdown 
# Keycloak Lua Docs

Namespace: `keycloak`

Keycloak exposes the official Admin REST API for realm administration. Tools are generated one-to-one from the Keycloak OpenAPI document and keep the upstream path, query, header, and body shape explicit.

## Configuration

Provide an admin bearer token in `access_token` and the Keycloak server root in `base_url`, for example `https://keycloak.example.test`. The connection test also asks for a `realm` because the Admin REST API is realm scoped.

## Usage Notes

- Most tools require `realm`; pass `master` or the tenant realm name explicitly.
- Path parameters with hyphens in the upstream API use snake_case arguments, such as `user_id` for `{user-id}`.
- Query parameters preserve Keycloak behavior but are exposed as snake_case arguments, such as `brief_representation` for `briefRepresentation`.
- For create and update endpoints, pass `body` as an object matching the Keycloak representation schema documented for that endpoint.
- Tool responses are parsed JSON when Keycloak returns JSON. Empty `204` responses return `{ success = true, status = 204 }`.

## Examples

```lua
local users = keycloak.keycloak_get_admin_realms_realm_users({
  realm = "master",
  username = "alice",
  exact = true,
  brief_representation = true,
})
```

```lua
local created = keycloak.keycloak_post_admin_realms_realm_users({
  realm = "master",
  body = {
    username = "agent-test-user",
    enabled = true,
    email = "[email protected]",
  },
})
```

Use fake domains and test users in examples and test fixtures. Do not put production realms, user emails, or tokens into committed docs.
Metadata-derived Lua example 
local result = app.integrations.keycloak.delete_realm({})
print(result)

Functions

delete_realm Write

Delete the realm.

Lua path
app.integrations.keycloak.delete_realm
Full name
keycloak.keycloak_delete_admin_realms_realm
ParameterTypeRequiredDescription
No parameters.
delete_all_admin_events Write

Delete all admin events.

Lua path
app.integrations.keycloak.delete_all_admin_events
Full name
keycloak.keycloak_delete_admin_realms_realm_admin_events
ParameterTypeRequiredDescription
No parameters.
clear_any_user_login_failures_all_users_this_can_release_temporary_disabled_users Write

Clear any user login failures for all users This can release temporary disabled users.

Lua path
app.integrations.keycloak.clear_any_user_login_failures_all_users_this_can_release_temporary_disabled_users
Full name
keycloak.keycloak_delete_admin_realms_realm_attack_detection_brute_force_users
ParameterTypeRequiredDescription
No parameters.
clear_any_user_login_failures_user_this_can_release_temporary_disabled_user Write

Clear any user login failures for the user This can release temporary disabled user.

Lua path
app.integrations.keycloak.clear_any_user_login_failures_user_this_can_release_temporary_disabled_user
Full name
keycloak.keycloak_delete_admin_realms_realm_attack_detection_brute_force_users_user_id
ParameterTypeRequiredDescription
No parameters.
delete_authenticator_configuration Write

Delete authenticator configuration.

Lua path
app.integrations.keycloak.delete_authenticator_configuration
Full name
keycloak.keycloak_delete_admin_realms_realm_authentication_config_id
ParameterTypeRequiredDescription
No parameters.
delete_execution Write

Delete execution.

Lua path
app.integrations.keycloak.delete_execution
Full name
keycloak.keycloak_delete_admin_realms_realm_authentication_executions_execution_id
ParameterTypeRequiredDescription
No parameters.
delete_authentication_flow Write

Delete an authentication flow.

Lua path
app.integrations.keycloak.delete_authentication_flow
Full name
keycloak.keycloak_delete_admin_realms_realm_authentication_flows_id
ParameterTypeRequiredDescription
No parameters.
delete_required_action Write

Delete required action.

Lua path
app.integrations.keycloak.delete_required_action
Full name
keycloak.keycloak_delete_admin_realms_realm_authentication_required_actions_alias
ParameterTypeRequiredDescription
No parameters.
delete_requiredaction_configuration Write

Delete RequiredAction configuration.

Lua path
app.integrations.keycloak.delete_requiredaction_configuration
Full name
keycloak.keycloak_delete_admin_realms_realm_authentication_required_actions_alias_config
ParameterTypeRequiredDescription
No parameters.
delete_client_scope Write

Delete the client scope.

Lua path
app.integrations.keycloak.delete_client_scope
Full name
keycloak.keycloak_delete_admin_realms_realm_client_scopes_client_scope_id
ParameterTypeRequiredDescription
No parameters.
delete_mapper Write

Delete the mapper.

Lua path
app.integrations.keycloak.delete_mapper
Full name
keycloak.keycloak_delete_admin_realms_realm_client_scopes_client_scope_id_protocol_mappers_models_id
ParameterTypeRequiredDescription
No parameters.
remove_client_level_roles_from_client_scope Write

Remove client-level roles from the client's scope.

Lua path
app.integrations.keycloak.remove_client_level_roles_from_client_scope
Full name
keycloak.keycloak_delete_admin_realms_realm_client_scopes_client_scope_id_scope_mappings_clients_client
ParameterTypeRequiredDescription
No parameters.
remove_set_realm_level_roles_from_client_scope Write

Remove a set of realm-level roles from the client's scope.

Lua path
app.integrations.keycloak.remove_set_realm_level_roles_from_client_scope
Full name
keycloak.keycloak_delete_admin_realms_realm_client_scopes_client_scope_id_scope_mappings_realm
ParameterTypeRequiredDescription
No parameters.
delete_client_scope Write

Delete the client scope.

Lua path
app.integrations.keycloak.delete_client_scope
Full name
keycloak.keycloak_delete_admin_realms_realm_client_templates_client_scope_id
ParameterTypeRequiredDescription
No parameters.
delete_mapper Write

Delete the mapper.

Lua path
app.integrations.keycloak.delete_mapper
Full name
keycloak.keycloak_delete_admin_realms_realm_client_templates_client_scope_id_protocol_mappers_models_id
ParameterTypeRequiredDescription
No parameters.
remove_client_level_roles_from_client_scope Write

Remove client-level roles from the client's scope.

Lua path
app.integrations.keycloak.remove_client_level_roles_from_client_scope
Full name
keycloak.keycloak_delete_admin_realms_realm_client_templates_client_scope_id_scope_mappings_clients_client
ParameterTypeRequiredDescription
No parameters.
remove_set_realm_level_roles_from_client_scope Write

Remove a set of realm-level roles from the client's scope.

Lua path
app.integrations.keycloak.remove_set_realm_level_roles_from_client_scope
Full name
keycloak.keycloak_delete_admin_realms_realm_client_templates_client_scope_id_scope_mappings_realm
ParameterTypeRequiredDescription
No parameters.
delete_client Write

Delete the client.

Lua path
app.integrations.keycloak.delete_client
Full name
keycloak.keycloak_delete_admin_realms_realm_clients_client_uuid
ParameterTypeRequiredDescription
No parameters.
delete_admin_realms_realm_clients_client_uuid_authz_resource_server_resource_resource_id Write

DELETE /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/resource/{resource-id}.

Lua path
app.integrations.keycloak.delete_admin_realms_realm_clients_client_uuid_authz_resource_server_resource_resource_id
Full name
keycloak.keycloak_delete_admin_realms_realm_clients_client_uuid_authz_resource_server_resource_resource_id
ParameterTypeRequiredDescription
No parameters.
delete_admin_realms_realm_clients_client_uuid_authz_resource_server_scope_scope_id Write

DELETE /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/scope/{scope-id}.

Lua path
app.integrations.keycloak.delete_admin_realms_realm_clients_client_uuid_authz_resource_server_scope_scope_id
Full name
keycloak.keycloak_delete_admin_realms_realm_clients_client_uuid_authz_resource_server_scope_scope_id
ParameterTypeRequiredDescription
No parameters.
invalidate_rotated_secret_client Write

Invalidate the rotated secret for the client.

Lua path
app.integrations.keycloak.invalidate_rotated_secret_client
Full name
keycloak.keycloak_delete_admin_realms_realm_clients_client_uuid_client_secret_rotated
ParameterTypeRequiredDescription
No parameters.
delete_admin_realms_realm_clients_client_uuid_default_client_scopes_clientscopeid Write

DELETE /admin/realms/{realm}/clients/{client-uuid}/default-client-scopes/{clientScopeId}.

Lua path
app.integrations.keycloak.delete_admin_realms_realm_clients_client_uuid_default_client_scopes_clientscopeid
Full name
keycloak.keycloak_delete_admin_realms_realm_clients_client_uuid_default_client_scopes_client_scope_id
ParameterTypeRequiredDescription
No parameters.
unregister_cluster_node_from_client Write

Unregister a cluster node from the client.

Lua path
app.integrations.keycloak.unregister_cluster_node_from_client
Full name
keycloak.keycloak_delete_admin_realms_realm_clients_client_uuid_nodes_node
ParameterTypeRequiredDescription
No parameters.
delete_admin_realms_realm_clients_client_uuid_optional_client_scopes_clientscopeid Write

DELETE /admin/realms/{realm}/clients/{client-uuid}/optional-client-scopes/{clientScopeId}.

Lua path
app.integrations.keycloak.delete_admin_realms_realm_clients_client_uuid_optional_client_scopes_clientscopeid
Full name
keycloak.keycloak_delete_admin_realms_realm_clients_client_uuid_optional_client_scopes_client_scope_id
ParameterTypeRequiredDescription
No parameters.
delete_mapper Write

Delete the mapper.

Lua path
app.integrations.keycloak.delete_mapper
Full name
keycloak.keycloak_delete_admin_realms_realm_clients_client_uuid_protocol_mappers_models_id
ParameterTypeRequiredDescription
No parameters.
delete_role_by_name Write

Delete a role by name.

Lua path
app.integrations.keycloak.delete_role_by_name
Full name
keycloak.keycloak_delete_admin_realms_realm_clients_client_uuid_roles_role_name
ParameterTypeRequiredDescription
No parameters.
remove_roles_from_role_composite Write

Remove roles from the role's composite.

Lua path
app.integrations.keycloak.remove_roles_from_role_composite
Full name
keycloak.keycloak_delete_admin_realms_realm_clients_client_uuid_roles_role_name_composites
ParameterTypeRequiredDescription
No parameters.
remove_client_level_roles_from_client_scope Write

Remove client-level roles from the client's scope.

Lua path
app.integrations.keycloak.remove_client_level_roles_from_client_scope
Full name
keycloak.keycloak_delete_admin_realms_realm_clients_client_uuid_scope_mappings_clients_client
ParameterTypeRequiredDescription
No parameters.
remove_set_realm_level_roles_from_client_scope Write

Remove a set of realm-level roles from the client's scope.

Lua path
app.integrations.keycloak.remove_set_realm_level_roles_from_client_scope
Full name
keycloak.keycloak_delete_admin_realms_realm_clients_client_uuid_scope_mappings_realm
ParameterTypeRequiredDescription
No parameters.
delete_admin_realms_realm_clients_initial_access_id Write

DELETE /admin/realms/{realm}/clients-initial-access/{id}.

Lua path
app.integrations.keycloak.delete_admin_realms_realm_clients_initial_access_id
Full name
keycloak.keycloak_delete_admin_realms_realm_clients_initial_access_id
ParameterTypeRequiredDescription
No parameters.
delete_admin_realms_realm_components_id Write

DELETE /admin/realms/{realm}/components/{id}.

Lua path
app.integrations.keycloak.delete_admin_realms_realm_components_id
Full name
keycloak.keycloak_delete_admin_realms_realm_components_id
ParameterTypeRequiredDescription
No parameters.
delete_admin_realms_realm_default_default_client_scopes_clientscopeid Write

DELETE /admin/realms/{realm}/default-default-client-scopes/{clientScopeId}.

Lua path
app.integrations.keycloak.delete_admin_realms_realm_default_default_client_scopes_clientscopeid
Full name
keycloak.keycloak_delete_admin_realms_realm_default_default_client_scopes_client_scope_id
ParameterTypeRequiredDescription
No parameters.
delete_admin_realms_realm_default_groups_groupid Write

DELETE /admin/realms/{realm}/default-groups/{groupId}.

Lua path
app.integrations.keycloak.delete_admin_realms_realm_default_groups_groupid
Full name
keycloak.keycloak_delete_admin_realms_realm_default_groups_group_id
ParameterTypeRequiredDescription
No parameters.
delete_admin_realms_realm_default_optional_client_scopes_clientscopeid Write

DELETE /admin/realms/{realm}/default-optional-client-scopes/{clientScopeId}.

Lua path
app.integrations.keycloak.delete_admin_realms_realm_default_optional_client_scopes_clientscopeid
Full name
keycloak.keycloak_delete_admin_realms_realm_default_optional_client_scopes_client_scope_id
ParameterTypeRequiredDescription
No parameters.
delete_all_events Write

Delete all events.

Lua path
app.integrations.keycloak.delete_all_events
Full name
keycloak.keycloak_delete_admin_realms_realm_events
ParameterTypeRequiredDescription
No parameters.
delete_admin_realms_realm_groups_group_id Write

DELETE /admin/realms/{realm}/groups/{group-id}.

Lua path
app.integrations.keycloak.delete_admin_realms_realm_groups_group_id
Full name
keycloak.keycloak_delete_admin_realms_realm_groups_group_id
ParameterTypeRequiredDescription
No parameters.
delete_client_level_roles_from_user_or_group_role_mapping Write

Delete client-level roles from user or group role mapping.

Lua path
app.integrations.keycloak.delete_client_level_roles_from_user_or_group_role_mapping
Full name
keycloak.keycloak_delete_admin_realms_realm_groups_group_id_role_mappings_clients_client_id
ParameterTypeRequiredDescription
No parameters.
delete_realm_level_role_mappings Write

Delete realm-level role mappings.

Lua path
app.integrations.keycloak.delete_realm_level_role_mappings
Full name
keycloak.keycloak_delete_admin_realms_realm_groups_group_id_role_mappings_realm
ParameterTypeRequiredDescription
No parameters.
delete_identity_provider Write

Delete the identity provider.

Lua path
app.integrations.keycloak.delete_identity_provider
Full name
keycloak.keycloak_delete_admin_realms_realm_identity_provider_instances_alias
ParameterTypeRequiredDescription
No parameters.
delete_mapper_identity_provider Write

Delete a mapper for the identity provider.

Lua path
app.integrations.keycloak.delete_mapper_identity_provider
Full name
keycloak.keycloak_delete_admin_realms_realm_identity_provider_instances_alias_mappers_id
ParameterTypeRequiredDescription
No parameters.
delete_admin_realms_realm_localization_locale Write

DELETE /admin/realms/{realm}/localization/{locale}.

Lua path
app.integrations.keycloak.delete_admin_realms_realm_localization_locale
Full name
keycloak.keycloak_delete_admin_realms_realm_localization_locale
ParameterTypeRequiredDescription
No parameters.
delete_admin_realms_realm_localization_locale Write

DELETE /admin/realms/{realm}/localization/{locale}/{key}.

Lua path
app.integrations.keycloak.delete_admin_realms_realm_localization_locale
Full name
keycloak.keycloak_delete_admin_realms_realm_localization_locale_key
ParameterTypeRequiredDescription
No parameters.
deletes_organization Write

Deletes the organization.

Lua path
app.integrations.keycloak.deletes_organization
Full name
keycloak.keycloak_delete_admin_realms_realm_organizations_org_id
ParameterTypeRequiredDescription
No parameters.
delete_organization_group Write

Deletes the organization group and all its subgroups

Lua path
app.integrations.keycloak.delete_organization_group
Full name
keycloak.keycloak_delete_admin_realms_realm_organizations_org_id_groups_group_id
ParameterTypeRequiredDescription
No parameters.
remove_user_from_this_organization_group Write

Removes a user from this organization group. The user remains a member of the organization.

Lua path
app.integrations.keycloak.remove_user_from_this_organization_group
Full name
keycloak.keycloak_delete_admin_realms_realm_organizations_org_id_groups_group_id_members_user_id
ParameterTypeRequiredDescription
No parameters.
removes_identity_provider_with_specified_alias_from_organization Write

Breaks the association between the identity provider and the organization. The provider itself is not deleted. If no provider is found, or if it is not currently associated with the org, an error response is returned

Lua path
app.integrations.keycloak.removes_identity_provider_with_specified_alias_from_organization
Full name
keycloak.keycloak_delete_admin_realms_realm_organizations_org_id_identity_providers_alias
ParameterTypeRequiredDescription
No parameters.
delete_invitation Write

Delete an invitation.

Lua path
app.integrations.keycloak.delete_invitation
Full name
keycloak.keycloak_delete_admin_realms_realm_organizations_org_id_invitations_id
ParameterTypeRequiredDescription
No parameters.
removes_user_with_specified_id_from_organization Write

Breaks the association between the user and organization. The user itself is deleted in case the membership is managed, otherwise the user is not deleted. If no user is found, or if they are not a member of the organization, an error response is returned

Lua path
app.integrations.keycloak.removes_user_with_specified_id_from_organization
Full name
keycloak.keycloak_delete_admin_realms_realm_organizations_org_id_members_member_id
ParameterTypeRequiredDescription
No parameters.
delete_role Write

Delete the role.

Lua path
app.integrations.keycloak.delete_role
Full name
keycloak.keycloak_delete_admin_realms_realm_roles_by_id_role_id
ParameterTypeRequiredDescription
No parameters.
remove_set_roles_from_role_composite Write

Remove a set of roles from the role's composite.

Lua path
app.integrations.keycloak.remove_set_roles_from_role_composite
Full name
keycloak.keycloak_delete_admin_realms_realm_roles_by_id_role_id_composites
ParameterTypeRequiredDescription
No parameters.
delete_role_by_name Write

Delete a role by name.

Lua path
app.integrations.keycloak.delete_role_by_name
Full name
keycloak.keycloak_delete_admin_realms_realm_roles_role_name
ParameterTypeRequiredDescription
No parameters.
remove_roles_from_role_composite Write

Remove roles from the role's composite.

Lua path
app.integrations.keycloak.remove_roles_from_role_composite
Full name
keycloak.keycloak_delete_admin_realms_realm_roles_role_name_composites
ParameterTypeRequiredDescription
No parameters.
remove_specific_user_session Write

Any client that has an admin url will also be told to invalidate this particular session.

Lua path
app.integrations.keycloak.remove_specific_user_session
Full name
keycloak.keycloak_delete_admin_realms_realm_sessions_session
ParameterTypeRequiredDescription
No parameters.
delete_user Write

Delete the user.

Lua path
app.integrations.keycloak.delete_user
Full name
keycloak.keycloak_delete_admin_realms_realm_users_user_id
ParameterTypeRequiredDescription
No parameters.
remove_credential_user Write

Remove a credential for a user.

Lua path
app.integrations.keycloak.remove_credential_user
Full name
keycloak.keycloak_delete_admin_realms_realm_users_user_id_credentials_credential_id
ParameterTypeRequiredDescription
No parameters.
remove_social_login_provider_from_user Write

Remove a social login provider from user.

Lua path
app.integrations.keycloak.remove_social_login_provider_from_user
Full name
keycloak.keycloak_delete_admin_realms_realm_users_user_id_federated_identity_provider
ParameterTypeRequiredDescription
No parameters.
delete_admin_realms_realm_users_user_id_groups_groupid Write

DELETE /admin/realms/{realm}/users/{user-id}/groups/{groupId}.

Lua path
app.integrations.keycloak.delete_admin_realms_realm_users_user_id_groups_groupid
Full name
keycloak.keycloak_delete_admin_realms_realm_users_user_id_groups_group_id
ParameterTypeRequiredDescription
No parameters.
delete_client_level_roles_from_user_or_group_role_mapping Write

Delete client-level roles from user or group role mapping.

Lua path
app.integrations.keycloak.delete_client_level_roles_from_user_or_group_role_mapping
Full name
keycloak.keycloak_delete_admin_realms_realm_users_user_id_role_mappings_clients_client_id
ParameterTypeRequiredDescription
No parameters.
delete_realm_level_role_mappings Write

Delete realm-level role mappings.

Lua path
app.integrations.keycloak.delete_realm_level_role_mappings
Full name
keycloak.keycloak_delete_admin_realms_realm_users_user_id_role_mappings_realm
ParameterTypeRequiredDescription
No parameters.
delete_workflow Write

Delete the workflow and its configuration.

Lua path
app.integrations.keycloak.delete_workflow
Full name
keycloak.keycloak_delete_admin_realms_realm_workflows_id
ParameterTypeRequiredDescription
No parameters.
get_accessible_realms_returns_list_accessible_realms_list_is_filtered_based_what_realms_caller_is_allowed_view Read

Get accessible realms Returns a list of accessible realms. The list is filtered based on what realms the caller is allowed to view.

Lua path
app.integrations.keycloak.get_accessible_realms_returns_list_accessible_realms_list_is_filtered_based_what_realms_caller_is_allowed_view
Full name
keycloak.keycloak_get_admin_realms
ParameterTypeRequiredDescription
No parameters.
get_top_level_representation_realm_it_will_not_include_nested_information_like_user_and_client_representations Read

Get the top-level representation of the realm It will not include nested information like User and Client representations.

Lua path
app.integrations.keycloak.get_top_level_representation_realm_it_will_not_include_nested_information_like_user_and_client_representations
Full name
keycloak.keycloak_get_admin_realms_realm
ParameterTypeRequiredDescription
No parameters.
get_admin_events_returns_all_admin_events_or_filters_events_based_url_query_parameters_listed_here Read

Get admin events Returns all admin events, or filters events based on URL query parameters listed here.

Lua path
app.integrations.keycloak.get_admin_events_returns_all_admin_events_or_filters_events_based_url_query_parameters_listed_here
Full name
keycloak.keycloak_get_admin_realms_realm_admin_events
ParameterTypeRequiredDescription
No parameters.
get_status_username_brute_force_detection Read

Get status of a username in brute force detection.

Lua path
app.integrations.keycloak.get_status_username_brute_force_detection
Full name
keycloak.keycloak_get_admin_realms_realm_attack_detection_brute_force_users_user_id
ParameterTypeRequiredDescription
No parameters.
get_authenticator_providers_returns_stream_authenticator_providers Read

Get authenticator providers Returns a stream of authenticator providers.

Lua path
app.integrations.keycloak.get_authenticator_providers_returns_stream_authenticator_providers
Full name
keycloak.keycloak_get_admin_realms_realm_authentication_authenticator_providers
ParameterTypeRequiredDescription
No parameters.
get_client_authenticator_providers_returns_stream_client_authenticator_providers Read

Get client authenticator providers Returns a stream of client authenticator providers.

Lua path
app.integrations.keycloak.get_client_authenticator_providers_returns_stream_client_authenticator_providers
Full name
keycloak.keycloak_get_admin_realms_realm_authentication_client_authenticator_providers
ParameterTypeRequiredDescription
No parameters.
get_authenticator_provider_configuration_description Read

Get authenticator provider's configuration description.

Lua path
app.integrations.keycloak.get_authenticator_provider_configuration_description
Full name
keycloak.keycloak_get_admin_realms_realm_authentication_config_description_provider_id
ParameterTypeRequiredDescription
No parameters.
get_authenticator_configuration Read

Get authenticator configuration.

Lua path
app.integrations.keycloak.get_authenticator_configuration
Full name
keycloak.keycloak_get_admin_realms_realm_authentication_config_id
ParameterTypeRequiredDescription
No parameters.
get_single_execution Read

Get Single Execution.

Lua path
app.integrations.keycloak.get_single_execution
Full name
keycloak.keycloak_get_admin_realms_realm_authentication_executions_execution_id
ParameterTypeRequiredDescription
No parameters.
get_execution_configuration Read

Get execution's configuration.

Lua path
app.integrations.keycloak.get_execution_configuration
Full name
keycloak.keycloak_get_admin_realms_realm_authentication_executions_execution_id_config_id
ParameterTypeRequiredDescription
No parameters.
get_authentication_flows_returns_stream_authentication_flows Read

Get authentication flows Returns a stream of authentication flows.

Lua path
app.integrations.keycloak.get_authentication_flows_returns_stream_authentication_flows
Full name
keycloak.keycloak_get_admin_realms_realm_authentication_flows
ParameterTypeRequiredDescription
No parameters.
get_authentication_executions_flow Read

Get authentication executions for a flow.

Lua path
app.integrations.keycloak.get_authentication_executions_flow
Full name
keycloak.keycloak_get_admin_realms_realm_authentication_flows_flow_alias_executions
ParameterTypeRequiredDescription
No parameters.
get_authentication_flow_id Read

Get authentication flow for id.

Lua path
app.integrations.keycloak.get_authentication_flow_id
Full name
keycloak.keycloak_get_admin_realms_realm_authentication_flows_id
ParameterTypeRequiredDescription
No parameters.
get_form_action_providers_returns_stream_form_action_providers Read

Get form action providers Returns a stream of form action providers.

Lua path
app.integrations.keycloak.get_form_action_providers_returns_stream_form_action_providers
Full name
keycloak.keycloak_get_admin_realms_realm_authentication_form_action_providers
ParameterTypeRequiredDescription
No parameters.
get_form_providers_returns_stream_form_providers Read

Get form providers Returns a stream of form providers.

Lua path
app.integrations.keycloak.get_form_providers_returns_stream_form_providers
Full name
keycloak.keycloak_get_admin_realms_realm_authentication_form_providers
ParameterTypeRequiredDescription
No parameters.
get_configuration_descriptions_all_clients Read

Get configuration descriptions for all clients.

Lua path
app.integrations.keycloak.get_configuration_descriptions_all_clients
Full name
keycloak.keycloak_get_admin_realms_realm_authentication_per_client_config_description
ParameterTypeRequiredDescription
No parameters.
get_required_actions_returns_stream_required_actions Read

Get required actions Returns a stream of required actions.

Lua path
app.integrations.keycloak.get_required_actions_returns_stream_required_actions
Full name
keycloak.keycloak_get_admin_realms_realm_authentication_required_actions
ParameterTypeRequiredDescription
No parameters.
get_required_action_alias Read

Get required action for alias.

Lua path
app.integrations.keycloak.get_required_action_alias
Full name
keycloak.keycloak_get_admin_realms_realm_authentication_required_actions_alias
ParameterTypeRequiredDescription
No parameters.
get_requiredaction_configuration Read

Get RequiredAction configuration.

Lua path
app.integrations.keycloak.get_requiredaction_configuration
Full name
keycloak.keycloak_get_admin_realms_realm_authentication_required_actions_alias_config
ParameterTypeRequiredDescription
No parameters.
get_requiredaction_provider_configuration_description Read

Get RequiredAction provider configuration description.

Lua path
app.integrations.keycloak.get_requiredaction_provider_configuration_description
Full name
keycloak.keycloak_get_admin_realms_realm_authentication_required_actions_alias_config_description
ParameterTypeRequiredDescription
No parameters.
get_unregistered_required_actions_returns_stream_unregistered_required_actions Read

Get unregistered required actions Returns a stream of unregistered required actions.

Lua path
app.integrations.keycloak.get_unregistered_required_actions_returns_stream_unregistered_required_actions
Full name
keycloak.keycloak_get_admin_realms_realm_authentication_unregistered_required_actions
ParameterTypeRequiredDescription
No parameters.
get_admin_realms_realm_client_policies_policies Read

GET /admin/realms/{realm}/client-policies/policies.

Lua path
app.integrations.keycloak.get_admin_realms_realm_client_policies_policies
Full name
keycloak.keycloak_get_admin_realms_realm_client_policies_policies
ParameterTypeRequiredDescription
No parameters.
get_admin_realms_realm_client_policies_profiles Read

GET /admin/realms/{realm}/client-policies/profiles.

Lua path
app.integrations.keycloak.get_admin_realms_realm_client_policies_profiles
Full name
keycloak.keycloak_get_admin_realms_realm_client_policies_profiles
ParameterTypeRequiredDescription
No parameters.
base_path_retrieve_providers_with_configproperties_properly_filled Read

Base path for retrieve providers with the configProperties properly filled.

Lua path
app.integrations.keycloak.base_path_retrieve_providers_with_configproperties_properly_filled
Full name
keycloak.keycloak_get_admin_realms_realm_client_registration_policy_providers
ParameterTypeRequiredDescription
No parameters.
get_client_scopes_belonging_realm_returns_list_client_scopes_belonging_realm Read

Get client scopes belonging to the realm Returns a list of client scopes belonging to the realm.

Lua path
app.integrations.keycloak.get_client_scopes_belonging_realm_returns_list_client_scopes_belonging_realm
Full name
keycloak.keycloak_get_admin_realms_realm_client_scopes
ParameterTypeRequiredDescription
No parameters.
get_representation_client_scope Read

Get representation of the client scope.

Lua path
app.integrations.keycloak.get_representation_client_scope
Full name
keycloak.keycloak_get_admin_realms_realm_client_scopes_client_scope_id
ParameterTypeRequiredDescription
No parameters.
get_mappers Read

Get mappers.

Lua path
app.integrations.keycloak.get_mappers
Full name
keycloak.keycloak_get_admin_realms_realm_client_scopes_client_scope_id_protocol_mappers_models
ParameterTypeRequiredDescription
No parameters.
get_mapper_by_id Read

Get mapper by id.

Lua path
app.integrations.keycloak.get_mapper_by_id
Full name
keycloak.keycloak_get_admin_realms_realm_client_scopes_client_scope_id_protocol_mappers_models_id
ParameterTypeRequiredDescription
No parameters.
get_mappers_by_name_specific_protocol Read

Get mappers by name for a specific protocol.

Lua path
app.integrations.keycloak.get_mappers_by_name_specific_protocol
Full name
keycloak.keycloak_get_admin_realms_realm_client_scopes_client_scope_id_protocol_mappers_protocol_protocol
ParameterTypeRequiredDescription
No parameters.
get_all_scope_mappings_client Read

Get all scope mappings for the client.

Lua path
app.integrations.keycloak.get_all_scope_mappings_client
Full name
keycloak.keycloak_get_admin_realms_realm_client_scopes_client_scope_id_scope_mappings
ParameterTypeRequiredDescription
No parameters.
get_roles_associated_with_client_scope_returns_roles_client Read

Get the roles associated with a client's scope Returns roles for the client.

Lua path
app.integrations.keycloak.get_roles_associated_with_client_scope_returns_roles_client
Full name
keycloak.keycloak_get_admin_realms_realm_client_scopes_client_scope_id_scope_mappings_clients_client
ParameterTypeRequiredDescription
No parameters.
available_client_level_roles_returns_roles_client_that_can_be_associated_with_client_scope Read

The available client-level roles Returns the roles for the client that can be associated with the client's scope.

Lua path
app.integrations.keycloak.available_client_level_roles_returns_roles_client_that_can_be_associated_with_client_scope
Full name
keycloak.keycloak_get_admin_realms_realm_client_scopes_client_scope_id_scope_mappings_clients_client_available
ParameterTypeRequiredDescription
No parameters.
get_effective_client_roles_returns_roles_client_that_are_associated_with_client_scope Read

Get effective client roles Returns the roles for the client that are associated with the client's scope.

Lua path
app.integrations.keycloak.get_effective_client_roles_returns_roles_client_that_are_associated_with_client_scope
Full name
keycloak.keycloak_get_admin_realms_realm_client_scopes_client_scope_id_scope_mappings_clients_client_composite
ParameterTypeRequiredDescription
No parameters.
get_realm_level_roles_associated_with_client_scope Read

Get realm-level roles associated with the client's scope.

Lua path
app.integrations.keycloak.get_realm_level_roles_associated_with_client_scope
Full name
keycloak.keycloak_get_admin_realms_realm_client_scopes_client_scope_id_scope_mappings_realm
ParameterTypeRequiredDescription
No parameters.
get_realm_level_roles_that_are_available_attach_this_client_scope Read

Get realm-level roles that are available to attach to this client's scope.

Lua path
app.integrations.keycloak.get_realm_level_roles_that_are_available_attach_this_client_scope
Full name
keycloak.keycloak_get_admin_realms_realm_client_scopes_client_scope_id_scope_mappings_realm_available
ParameterTypeRequiredDescription
No parameters.
get_effective_realm_level_roles_associated_with_client_scope_what_this_does_is_recurse_any_composite_roles_associated_with_client_scope_and_adds_roles_this_lists Read

The method is really to show a comprehensive total view of realm-level roles associated with the client.

Lua path
app.integrations.keycloak.get_effective_realm_level_roles_associated_with_client_scope_what_this_does_is_recurse_any_composite_roles_associated_with_client_scope_and_adds_roles_this_lists
Full name
keycloak.keycloak_get_admin_realms_realm_client_scopes_client_scope_id_scope_mappings_realm_composite
ParameterTypeRequiredDescription
No parameters.
get_client_session_stats_returns_json_map Read

The key is the client id, the value is the number of sessions that currently are active with that client. Only clients that actually have a session associated with them will be in this map.

Lua path
app.integrations.keycloak.get_client_session_stats_returns_json_map
Full name
keycloak.keycloak_get_admin_realms_realm_client_session_stats
ParameterTypeRequiredDescription
No parameters.
get_client_scopes_belonging_realm_returns_list_client_scopes_belonging_realm Read

Get client scopes belonging to the realm Returns a list of client scopes belonging to the realm.

Lua path
app.integrations.keycloak.get_client_scopes_belonging_realm_returns_list_client_scopes_belonging_realm
Full name
keycloak.keycloak_get_admin_realms_realm_client_templates
ParameterTypeRequiredDescription
No parameters.
get_representation_client_scope Read

Get representation of the client scope.

Lua path
app.integrations.keycloak.get_representation_client_scope
Full name
keycloak.keycloak_get_admin_realms_realm_client_templates_client_scope_id
ParameterTypeRequiredDescription
No parameters.
get_mappers Read

Get mappers.

Lua path
app.integrations.keycloak.get_mappers
Full name
keycloak.keycloak_get_admin_realms_realm_client_templates_client_scope_id_protocol_mappers_models
ParameterTypeRequiredDescription
No parameters.
get_mapper_by_id Read

Get mapper by id.

Lua path
app.integrations.keycloak.get_mapper_by_id
Full name
keycloak.keycloak_get_admin_realms_realm_client_templates_client_scope_id_protocol_mappers_models_id
ParameterTypeRequiredDescription
No parameters.
get_mappers_by_name_specific_protocol Read

Get mappers by name for a specific protocol.

Lua path
app.integrations.keycloak.get_mappers_by_name_specific_protocol
Full name
keycloak.keycloak_get_admin_realms_realm_client_templates_client_scope_id_protocol_mappers_protocol_protocol
ParameterTypeRequiredDescription
No parameters.
get_all_scope_mappings_client Read

Get all scope mappings for the client.

Lua path
app.integrations.keycloak.get_all_scope_mappings_client
Full name
keycloak.keycloak_get_admin_realms_realm_client_templates_client_scope_id_scope_mappings
ParameterTypeRequiredDescription
No parameters.
get_roles_associated_with_client_scope_returns_roles_client Read

Get the roles associated with a client's scope Returns roles for the client.

Lua path
app.integrations.keycloak.get_roles_associated_with_client_scope_returns_roles_client
Full name
keycloak.keycloak_get_admin_realms_realm_client_templates_client_scope_id_scope_mappings_clients_client
ParameterTypeRequiredDescription
No parameters.
available_client_level_roles_returns_roles_client_that_can_be_associated_with_client_scope Read

The available client-level roles Returns the roles for the client that can be associated with the client's scope.

Lua path
app.integrations.keycloak.available_client_level_roles_returns_roles_client_that_can_be_associated_with_client_scope
Full name
keycloak.keycloak_get_admin_realms_realm_client_templates_client_scope_id_scope_mappings_clients_client_available
ParameterTypeRequiredDescription
No parameters.
get_effective_client_roles_returns_roles_client_that_are_associated_with_client_scope Read

Get effective client roles Returns the roles for the client that are associated with the client's scope.

Lua path
app.integrations.keycloak.get_effective_client_roles_returns_roles_client_that_are_associated_with_client_scope
Full name
keycloak.keycloak_get_admin_realms_realm_client_templates_client_scope_id_scope_mappings_clients_client_composite
ParameterTypeRequiredDescription
No parameters.
get_realm_level_roles_associated_with_client_scope Read

Get realm-level roles associated with the client's scope.

Lua path
app.integrations.keycloak.get_realm_level_roles_associated_with_client_scope
Full name
keycloak.keycloak_get_admin_realms_realm_client_templates_client_scope_id_scope_mappings_realm
ParameterTypeRequiredDescription
No parameters.
get_realm_level_roles_that_are_available_attach_this_client_scope Read

Get realm-level roles that are available to attach to this client's scope.

Lua path
app.integrations.keycloak.get_realm_level_roles_that_are_available_attach_this_client_scope
Full name
keycloak.keycloak_get_admin_realms_realm_client_templates_client_scope_id_scope_mappings_realm_available
ParameterTypeRequiredDescription
No parameters.
get_effective_realm_level_roles_associated_with_client_scope_what_this_does_is_recurse_any_composite_roles_associated_with_client_scope_and_adds_roles_this_lists Read

The method is really to show a comprehensive total view of realm-level roles associated with the client.

Lua path
app.integrations.keycloak.get_effective_realm_level_roles_associated_with_client_scope_what_this_does_is_recurse_any_composite_roles_associated_with_client_scope_and_adds_roles_this_lists
Full name
keycloak.keycloak_get_admin_realms_realm_client_templates_client_scope_id_scope_mappings_realm_composite
ParameterTypeRequiredDescription
No parameters.
list_all_client_types_available_current_realm Read

This endpoint returns a list of both global and realm level client types and the attributes they set

Lua path
app.integrations.keycloak.list_all_client_types_available_current_realm
Full name
keycloak.keycloak_get_admin_realms_realm_client_types
ParameterTypeRequiredDescription
No parameters.
get_clients_belonging_realm Read

If a client can’t be retrieved from the storage due to a problem with the underlying storage, it is silently removed from the returned list. This ensures that concurrent modifications to the list don’t prevent callers from retrieving this list.

Lua path
app.integrations.keycloak.get_clients_belonging_realm
Full name
keycloak.keycloak_get_admin_realms_realm_clients
ParameterTypeRequiredDescription
No parameters.
get_representation_client Read

Get representation of the client.

Lua path
app.integrations.keycloak.get_representation_client
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid
ParameterTypeRequiredDescription
No parameters.
get_admin_realms_realm_clients_client_uuid_authz_resource_server Read

GET /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server.

Lua path
app.integrations.keycloak.get_admin_realms_realm_clients_client_uuid_authz_resource_server
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_authz_resource_server
ParameterTypeRequiredDescription
No parameters.
get_admin_realms_realm_clients_client_uuid_authz_resource_server_permission Read

GET /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/permission.

Lua path
app.integrations.keycloak.get_admin_realms_realm_clients_client_uuid_authz_resource_server_permission
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_authz_resource_server_permission
ParameterTypeRequiredDescription
No parameters.
get_admin_realms_realm_clients_client_uuid_authz_resource_server_permission_providers Read

GET /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/permission/providers.

Lua path
app.integrations.keycloak.get_admin_realms_realm_clients_client_uuid_authz_resource_server_permission_providers
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_authz_resource_server_permission_providers
ParameterTypeRequiredDescription
No parameters.
get_admin_realms_realm_clients_client_uuid_authz_resource_server_policy Read

GET /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/policy.

Lua path
app.integrations.keycloak.get_admin_realms_realm_clients_client_uuid_authz_resource_server_policy
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_authz_resource_server_policy
ParameterTypeRequiredDescription
No parameters.
get_admin_realms_realm_clients_client_uuid_authz_resource_server_policy_providers Read

GET /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/policy/providers.

Lua path
app.integrations.keycloak.get_admin_realms_realm_clients_client_uuid_authz_resource_server_policy_providers
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_authz_resource_server_policy_providers
ParameterTypeRequiredDescription
No parameters.
get_admin_realms_realm_clients_client_uuid_authz_resource_server_resource Read

GET /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/resource.

Lua path
app.integrations.keycloak.get_admin_realms_realm_clients_client_uuid_authz_resource_server_resource
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_authz_resource_server_resource
ParameterTypeRequiredDescription
No parameters.
get_admin_realms_realm_clients_client_uuid_authz_resource_server_resource_resource_id Read

GET /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/resource/{resource-id}.

Lua path
app.integrations.keycloak.get_admin_realms_realm_clients_client_uuid_authz_resource_server_resource_resource_id
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_authz_resource_server_resource_resource_id
ParameterTypeRequiredDescription
No parameters.
get_admin_realms_realm_clients_client_uuid_authz_resource_server_resource_resource_id_attributes Read

GET /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/resource/{resource-id}/attributes.

Lua path
app.integrations.keycloak.get_admin_realms_realm_clients_client_uuid_authz_resource_server_resource_resource_id_attributes
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_authz_resource_server_resource_resource_id_attributes
ParameterTypeRequiredDescription
No parameters.
get_admin_realms_realm_clients_client_uuid_authz_resource_server_resource_resource_id_permissions Read

GET /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/resource/{resource-id}/permissions.

Lua path
app.integrations.keycloak.get_admin_realms_realm_clients_client_uuid_authz_resource_server_resource_resource_id_permissions
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_authz_resource_server_resource_resource_id_permissions
ParameterTypeRequiredDescription
No parameters.
get_admin_realms_realm_clients_client_uuid_authz_resource_server_resource_resource_id_scopes Read

GET /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/resource/{resource-id}/scopes.

Lua path
app.integrations.keycloak.get_admin_realms_realm_clients_client_uuid_authz_resource_server_resource_resource_id_scopes
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_authz_resource_server_resource_resource_id_scopes
ParameterTypeRequiredDescription
No parameters.
get_admin_realms_realm_clients_client_uuid_authz_resource_server_scope Read

GET /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/scope.

Lua path
app.integrations.keycloak.get_admin_realms_realm_clients_client_uuid_authz_resource_server_scope
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_authz_resource_server_scope
ParameterTypeRequiredDescription
No parameters.
get_admin_realms_realm_clients_client_uuid_authz_resource_server_scope_scope_id Read

GET /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/scope/{scope-id}.

Lua path
app.integrations.keycloak.get_admin_realms_realm_clients_client_uuid_authz_resource_server_scope_scope_id
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_authz_resource_server_scope_scope_id
ParameterTypeRequiredDescription
No parameters.
get_admin_realms_realm_clients_client_uuid_authz_resource_server_scope_scope_id_permissions Read

GET /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/scope/{scope-id}/permissions.

Lua path
app.integrations.keycloak.get_admin_realms_realm_clients_client_uuid_authz_resource_server_scope_scope_id_permissions
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_authz_resource_server_scope_scope_id_permissions
ParameterTypeRequiredDescription
No parameters.
get_admin_realms_realm_clients_client_uuid_authz_resource_server_scope_scope_id_resources Read

GET /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/scope/{scope-id}/resources.

Lua path
app.integrations.keycloak.get_admin_realms_realm_clients_client_uuid_authz_resource_server_scope_scope_id_resources
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_authz_resource_server_scope_scope_id_resources
ParameterTypeRequiredDescription
No parameters.
get_admin_realms_realm_clients_client_uuid_authz_resource_server_settings Read

GET /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/settings.

Lua path
app.integrations.keycloak.get_admin_realms_realm_clients_client_uuid_authz_resource_server_settings
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_authz_resource_server_settings
ParameterTypeRequiredDescription
No parameters.
get_info Read

Get key info.

Lua path
app.integrations.keycloak.get_info
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_certificates_attr
ParameterTypeRequiredDescription
No parameters.
get_client_secret Read

Get the client secret.

Lua path
app.integrations.keycloak.get_client_secret
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_client_secret
ParameterTypeRequiredDescription
No parameters.
get_rotated_client_secret Read

Get the rotated client secret.

Lua path
app.integrations.keycloak.get_rotated_client_secret
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_client_secret_rotated
ParameterTypeRequiredDescription
No parameters.
get_default_client_scopes_only_name_and_ids_are_returned Read

Get default client scopes. Only name and ids are returned.

Lua path
app.integrations.keycloak.get_default_client_scopes_only_name_and_ids_are_returned
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_default_client_scopes
ParameterTypeRequiredDescription
No parameters.
create_json_with_payload_example_access_token Read

Create JSON with payload of example access token.

Lua path
app.integrations.keycloak.create_json_with_payload_example_access_token
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_evaluate_scopes_generate_example_access_token
ParameterTypeRequiredDescription
No parameters.
create_json_with_payload_example_id_token Read

Create JSON with payload of example id token.

Lua path
app.integrations.keycloak.create_json_with_payload_example_id_token
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_evaluate_scopes_generate_example_id_token
ParameterTypeRequiredDescription
No parameters.
create_json_with_payload_example_user_info Read

Create JSON with payload of example user info.

Lua path
app.integrations.keycloak.create_json_with_payload_example_user_info
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_evaluate_scopes_generate_example_userinfo
ParameterTypeRequiredDescription
No parameters.
return_list_all_protocol_mappers_which_will_be_used_when_generating_tokens_issued_particular_client Read

This means protocol mappers assigned to this client directly and protocol mappers assigned to all client scopes of this client.

Lua path
app.integrations.keycloak.return_list_all_protocol_mappers_which_will_be_used_when_generating_tokens_issued_particular_client
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_evaluate_scopes_protocol_mappers
ParameterTypeRequiredDescription
No parameters.
get_effective_scope_mapping_all_roles_particular_role_container_which_this_client_is_defacto_allowed_have_accesstoken_issued_him Read

This contains scope mappings, which this client has directly, as well as scope mappings, which are granted to all client scopes, which are linked with this client.

Lua path
app.integrations.keycloak.get_effective_scope_mapping_all_roles_particular_role_container_which_this_client_is_defacto_allowed_have_accesstoken_issued_him
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_evaluate_scopes_scope_mappings_role_container_id_granted
ParameterTypeRequiredDescription
No parameters.
get_roles_which_this_client_doesn_t_have_scope_and_can_t_have_them_accesstoken_issued_him Read

Defacto all the other roles of particular role container, which are not in {@link #getGrantedScopeMappings()}

Lua path
app.integrations.keycloak.get_roles_which_this_client_doesn_t_have_scope_and_can_t_have_them_accesstoken_issued_him
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_evaluate_scopes_scope_mappings_role_container_id_not_granted
ParameterTypeRequiredDescription
No parameters.
get_admin_realms_realm_clients_client_uuid_installation_providers_providerid Read

GET /admin/realms/{realm}/clients/{client-uuid}/installation/providers/{providerId}.

Lua path
app.integrations.keycloak.get_admin_realms_realm_clients_client_uuid_installation_providers_providerid
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_installation_providers_provider_id
ParameterTypeRequiredDescription
No parameters.
return_object_stating_whether_client_authorization_permissions_have_been_initialized_or_not_and_reference Read

Return object stating whether client Authorization permissions have been initialized or not and a reference.

Lua path
app.integrations.keycloak.return_object_stating_whether_client_authorization_permissions_have_been_initialized_or_not_and_reference
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_management_permissions
ParameterTypeRequiredDescription
No parameters.
get_application_offline_session_count_returns_number_offline_user_sessions_associated_with_this_client_count_number Read

Get application offline session count Returns a number of offline user sessions associated with this client { "count": number }.

Lua path
app.integrations.keycloak.get_application_offline_session_count_returns_number_offline_user_sessions_associated_with_this_client_count_number
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_offline_session_count
ParameterTypeRequiredDescription
No parameters.
get_offline_sessions_client_returns_list_offline_user_sessions_associated_with_this_client Read

Get offline sessions for client Returns a list of offline user sessions associated with this client.

Lua path
app.integrations.keycloak.get_offline_sessions_client_returns_list_offline_user_sessions_associated_with_this_client
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_offline_sessions
ParameterTypeRequiredDescription
No parameters.
get_optional_client_scopes_only_name_and_ids_are_returned Read

Get optional client scopes. Only name and ids are returned.

Lua path
app.integrations.keycloak.get_optional_client_scopes_only_name_and_ids_are_returned
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_optional_client_scopes
ParameterTypeRequiredDescription
No parameters.
get_mappers Read

Get mappers.

Lua path
app.integrations.keycloak.get_mappers
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_protocol_mappers_models
ParameterTypeRequiredDescription
No parameters.
get_mapper_by_id Read

Get mapper by id.

Lua path
app.integrations.keycloak.get_mapper_by_id
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_protocol_mappers_models_id
ParameterTypeRequiredDescription
No parameters.
get_mappers_by_name_specific_protocol Read

Get mappers by name for a specific protocol.

Lua path
app.integrations.keycloak.get_mappers_by_name_specific_protocol
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_protocol_mappers_protocol_protocol
ParameterTypeRequiredDescription
No parameters.
get_all_roles_realm_or_client Read

Get all roles for the realm or client.

Lua path
app.integrations.keycloak.get_all_roles_realm_or_client
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_roles
ParameterTypeRequiredDescription
No parameters.
get_role_by_name Read

Get a role by name.

Lua path
app.integrations.keycloak.get_role_by_name
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_roles_role_name
ParameterTypeRequiredDescription
No parameters.
get_composites_role Read

Get composites of the role.

Lua path
app.integrations.keycloak.get_composites_role
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_roles_role_name_composites
ParameterTypeRequiredDescription
No parameters.
get_client_level_roles_client_that_are_role_composite Read

Get client-level roles for the client that are in the role's composite.

Lua path
app.integrations.keycloak.get_client_level_roles_client_that_are_role_composite
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_roles_role_name_composites_clients_target_client_uuid
ParameterTypeRequiredDescription
No parameters.
get_realm_level_roles_role_composite Read

Get realm-level roles of the role's composite.

Lua path
app.integrations.keycloak.get_realm_level_roles_role_composite
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_roles_role_name_composites_realm
ParameterTypeRequiredDescription
No parameters.
returns_stream_groups_that_have_specified_role_name Read

Returns a stream of groups that have the specified role name.

Lua path
app.integrations.keycloak.returns_stream_groups_that_have_specified_role_name
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_roles_role_name_groups
ParameterTypeRequiredDescription
No parameters.
return_object_stating_whether_role_authorization_permissions_have_been_initialized_or_not_and_reference Read

Return object stating whether role Authorization permissions have been initialized or not and a reference.

Lua path
app.integrations.keycloak.return_object_stating_whether_role_authorization_permissions_have_been_initialized_or_not_and_reference
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_roles_role_name_management_permissions
ParameterTypeRequiredDescription
No parameters.
returns_stream_users_that_have_specified_role_name Read

Returns a stream of users that have the specified role name.

Lua path
app.integrations.keycloak.returns_stream_users_that_have_specified_role_name
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_roles_role_name_users
ParameterTypeRequiredDescription
No parameters.
get_all_scope_mappings_client Read

Get all scope mappings for the client.

Lua path
app.integrations.keycloak.get_all_scope_mappings_client
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_scope_mappings
ParameterTypeRequiredDescription
No parameters.
get_roles_associated_with_client_scope_returns_roles_client Read

Get the roles associated with a client's scope Returns roles for the client.

Lua path
app.integrations.keycloak.get_roles_associated_with_client_scope_returns_roles_client
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_scope_mappings_clients_client
ParameterTypeRequiredDescription
No parameters.
available_client_level_roles_returns_roles_client_that_can_be_associated_with_client_scope Read

The available client-level roles Returns the roles for the client that can be associated with the client's scope.

Lua path
app.integrations.keycloak.available_client_level_roles_returns_roles_client_that_can_be_associated_with_client_scope
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_scope_mappings_clients_client_available
ParameterTypeRequiredDescription
No parameters.
get_effective_client_roles_returns_roles_client_that_are_associated_with_client_scope Read

Get effective client roles Returns the roles for the client that are associated with the client's scope.

Lua path
app.integrations.keycloak.get_effective_client_roles_returns_roles_client_that_are_associated_with_client_scope
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_scope_mappings_clients_client_composite
ParameterTypeRequiredDescription
No parameters.
get_realm_level_roles_associated_with_client_scope Read

Get realm-level roles associated with the client's scope.

Lua path
app.integrations.keycloak.get_realm_level_roles_associated_with_client_scope
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_scope_mappings_realm
ParameterTypeRequiredDescription
No parameters.
get_realm_level_roles_that_are_available_attach_this_client_scope Read

Get realm-level roles that are available to attach to this client's scope.

Lua path
app.integrations.keycloak.get_realm_level_roles_that_are_available_attach_this_client_scope
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_scope_mappings_realm_available
ParameterTypeRequiredDescription
No parameters.
get_effective_realm_level_roles_associated_with_client_scope_what_this_does_is_recurse_any_composite_roles_associated_with_client_scope_and_adds_roles_this_lists Read

The method is really to show a comprehensive total view of realm-level roles associated with the client.

Lua path
app.integrations.keycloak.get_effective_realm_level_roles_associated_with_client_scope_what_this_does_is_recurse_any_composite_roles_associated_with_client_scope_and_adds_roles_this_lists
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_scope_mappings_realm_composite
ParameterTypeRequiredDescription
No parameters.
get_user_dedicated_service_account Read

Get a user dedicated to the service account.

Lua path
app.integrations.keycloak.get_user_dedicated_service_account
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_service_account_user
ParameterTypeRequiredDescription
No parameters.
get_application_session_count_returns_number_user_sessions_associated_with_this_client_count_number Read

Get application session count Returns a number of user sessions associated with this client { "count": number }.

Lua path
app.integrations.keycloak.get_application_session_count_returns_number_user_sessions_associated_with_this_client_count_number
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_session_count
ParameterTypeRequiredDescription
No parameters.
test_if_registered_cluster_nodes_are_available_tests_availability_by_sending_ping_request_all_cluster_nodes Read

Test if registered cluster nodes are available Tests availability by sending 'ping' request to all cluster nodes.

Lua path
app.integrations.keycloak.test_if_registered_cluster_nodes_are_available_tests_availability_by_sending_ping_request_all_cluster_nodes
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_test_nodes_available
ParameterTypeRequiredDescription
No parameters.
get_user_sessions_client_returns_list_user_sessions_associated_with_this_client Read

Get user sessions for client Returns a list of user sessions associated with this client.

Lua path
app.integrations.keycloak.get_user_sessions_client_returns_list_user_sessions_associated_with_this_client
Full name
keycloak.keycloak_get_admin_realms_realm_clients_client_uuid_user_sessions
ParameterTypeRequiredDescription
No parameters.
get_admin_realms_realm_clients_initial_access Read

GET /admin/realms/{realm}/clients-initial-access.

Lua path
app.integrations.keycloak.get_admin_realms_realm_clients_initial_access
Full name
keycloak.keycloak_get_admin_realms_realm_clients_initial_access
ParameterTypeRequiredDescription
No parameters.
get_admin_realms_realm_components Read

GET /admin/realms/{realm}/components.

Lua path
app.integrations.keycloak.get_admin_realms_realm_components
Full name
keycloak.keycloak_get_admin_realms_realm_components
ParameterTypeRequiredDescription
No parameters.
get_admin_realms_realm_components_id Read

GET /admin/realms/{realm}/components/{id}.

Lua path
app.integrations.keycloak.get_admin_realms_realm_components_id
Full name
keycloak.keycloak_get_admin_realms_realm_components_id
ParameterTypeRequiredDescription
No parameters.
list_subcomponent_types_that_are_available_configure_particular_parent_component Read

List of subcomponent types that are available to configure for a particular parent component.

Lua path
app.integrations.keycloak.list_subcomponent_types_that_are_available_configure_particular_parent_component
Full name
keycloak.keycloak_get_admin_realms_realm_components_id_sub_component_types
ParameterTypeRequiredDescription
No parameters.
get_admin_realms_realm_credential_registrators Read

GET /admin/realms/{realm}/credential-registrators.

Lua path
app.integrations.keycloak.get_admin_realms_realm_credential_registrators
Full name
keycloak.keycloak_get_admin_realms_realm_credential_registrators
ParameterTypeRequiredDescription
No parameters.
get_realm_default_client_scopes_only_name_and_ids_are_returned Read

Get realm default client scopes. Only name and ids are returned.

Lua path
app.integrations.keycloak.get_realm_default_client_scopes_only_name_and_ids_are_returned
Full name
keycloak.keycloak_get_admin_realms_realm_default_default_client_scopes
ParameterTypeRequiredDescription
No parameters.
get_group_hierarchy_only_name_and_ids_are_returned Read

Get group hierarchy. Only name and ids are returned.

Lua path
app.integrations.keycloak.get_group_hierarchy_only_name_and_ids_are_returned
Full name
keycloak.keycloak_get_admin_realms_realm_default_groups
ParameterTypeRequiredDescription
No parameters.
get_realm_optional_client_scopes_only_name_and_ids_are_returned Read

Get realm optional client scopes. Only name and ids are returned.

Lua path
app.integrations.keycloak.get_realm_optional_client_scopes_only_name_and_ids_are_returned
Full name
keycloak.keycloak_get_admin_realms_realm_default_optional_client_scopes
ParameterTypeRequiredDescription
No parameters.
get_events_returns_all_events_or_filters_them_based_url_query_parameters_listed_here Read

Get events Returns all events, or filters them based on URL query parameters listed here.

Lua path
app.integrations.keycloak.get_events_returns_all_events_or_filters_them_based_url_query_parameters_listed_here
Full name
keycloak.keycloak_get_admin_realms_realm_events
ParameterTypeRequiredDescription
No parameters.
get_events_provider_configuration_returns_json_object_with_events_provider_configuration Read

Get the events provider configuration Returns JSON object with events provider configuration.

Lua path
app.integrations.keycloak.get_events_provider_configuration_returns_json_object_with_events_provider_configuration
Full name
keycloak.keycloak_get_admin_realms_realm_events_config
ParameterTypeRequiredDescription
No parameters.
get_admin_realms_realm_group_by_path_path Read

GET /admin/realms/{realm}/group-by-path/{path}.

Lua path
app.integrations.keycloak.get_admin_realms_realm_group_by_path_path
Full name
keycloak.keycloak_get_admin_realms_realm_group_by_path_path
ParameterTypeRequiredDescription
No parameters.
get_group_hierarchy_only_name_and_id_are_returned_subgroups_are_only_returned_when_using_search_or_q_parameter_if_none_these_parameters_is_provided_top_level_groups_are_returned_without_subgroups_being_filled Read

Get group hierarchy. Only `name` and `id` are returned. `subGroups` are only returned when using the `search` or `q` parameter. If none of these parameters is provided, the top-level groups are returned without `subGroups` being filled.

Lua path
app.integrations.keycloak.get_group_hierarchy_only_name_and_id_are_returned_subgroups_are_only_returned_when_using_search_or_q_parameter_if_none_these_parameters_is_provided_top_level_groups_are_returned_without_subgroups_being_filled
Full name
keycloak.keycloak_get_admin_realms_realm_groups
ParameterTypeRequiredDescription
No parameters.
returns_groups_counts Read

Returns the groups counts.

Lua path
app.integrations.keycloak.returns_groups_counts
Full name
keycloak.keycloak_get_admin_realms_realm_groups_count
ParameterTypeRequiredDescription
No parameters.
get_admin_realms_realm_groups_group_id Read

GET /admin/realms/{realm}/groups/{group-id}.

Lua path
app.integrations.keycloak.get_admin_realms_realm_groups_group_id
Full name
keycloak.keycloak_get_admin_realms_realm_groups_group_id
ParameterTypeRequiredDescription
No parameters.
return_paginated_list_subgroups_that_have_parent_group_corresponding_group_url Read

Return a paginated list of subgroups that have a parent group corresponding to the group on the URL.

Lua path
app.integrations.keycloak.return_paginated_list_subgroups_that_have_parent_group_corresponding_group_url
Full name
keycloak.keycloak_get_admin_realms_realm_groups_group_id_children
ParameterTypeRequiredDescription
No parameters.
return_object_stating_whether_client_authorization_permissions_have_been_initialized_or_not_and_reference Read

Return object stating whether client Authorization permissions have been initialized or not and a reference.

Lua path
app.integrations.keycloak.return_object_stating_whether_client_authorization_permissions_have_been_initialized_or_not_and_reference
Full name
keycloak.keycloak_get_admin_realms_realm_groups_group_id_management_permissions
ParameterTypeRequiredDescription
No parameters.
get_users_returns_stream_users_filtered_according_query_parameters Read

Get users Returns a stream of users, filtered according to query parameters.

Lua path
app.integrations.keycloak.get_users_returns_stream_users_filtered_according_query_parameters
Full name
keycloak.keycloak_get_admin_realms_realm_groups_group_id_members
ParameterTypeRequiredDescription
No parameters.
get_role_mappings Read

Get role mappings.

Lua path
app.integrations.keycloak.get_role_mappings
Full name
keycloak.keycloak_get_admin_realms_realm_groups_group_id_role_mappings
ParameterTypeRequiredDescription
No parameters.
get_client_level_role_mappings_user_or_group_and_app Read

Get client-level role mappings for the user or group, and the app.

Lua path
app.integrations.keycloak.get_client_level_role_mappings_user_or_group_and_app
Full name
keycloak.keycloak_get_admin_realms_realm_groups_group_id_role_mappings_clients_client_id
ParameterTypeRequiredDescription
No parameters.
get_available_client_level_roles_that_can_be_mapped_user_or_group Read

Get available client-level roles that can be mapped to the user or group.

Lua path
app.integrations.keycloak.get_available_client_level_roles_that_can_be_mapped_user_or_group
Full name
keycloak.keycloak_get_admin_realms_realm_groups_group_id_role_mappings_clients_client_id_available
ParameterTypeRequiredDescription
No parameters.
get_effective_client_level_role_mappings_this_recurses_any_composite_roles Read

Get effective client-level role mappings This recurses any composite roles.

Lua path
app.integrations.keycloak.get_effective_client_level_role_mappings_this_recurses_any_composite_roles
Full name
keycloak.keycloak_get_admin_realms_realm_groups_group_id_role_mappings_clients_client_id_composite
ParameterTypeRequiredDescription
No parameters.
get_realm_level_role_mappings Read

Get realm-level role mappings.

Lua path
app.integrations.keycloak.get_realm_level_role_mappings
Full name
keycloak.keycloak_get_admin_realms_realm_groups_group_id_role_mappings_realm
ParameterTypeRequiredDescription
No parameters.
get_realm_level_roles_that_can_be_mapped Read

Get realm-level roles that can be mapped.

Lua path
app.integrations.keycloak.get_realm_level_roles_that_can_be_mapped
Full name
keycloak.keycloak_get_admin_realms_realm_groups_group_id_role_mappings_realm_available
ParameterTypeRequiredDescription
No parameters.
get_effective_realm_level_role_mappings_this_will_recurse_all_composite_roles_get_result Read

Get effective realm-level role mappings This will recurse all composite roles to get the result.

Lua path
app.integrations.keycloak.get_effective_realm_level_role_mappings_this_will_recurse_all_composite_roles_get_result
Full name
keycloak.keycloak_get_admin_realms_realm_groups_group_id_role_mappings_realm_composite
ParameterTypeRequiredDescription
No parameters.
list_identity_providers Read

List identity providers.

Lua path
app.integrations.keycloak.list_identity_providers
Full name
keycloak.keycloak_get_admin_realms_realm_identity_provider_instances
ParameterTypeRequiredDescription
No parameters.
get_identity_provider Read

Get the identity provider.

Lua path
app.integrations.keycloak.get_identity_provider
Full name
keycloak.keycloak_get_admin_realms_realm_identity_provider_instances_alias
ParameterTypeRequiredDescription
No parameters.
export_public_broker_configuration_identity_provider Read

Export public broker configuration for identity provider.

Lua path
app.integrations.keycloak.export_public_broker_configuration_identity_provider
Full name
keycloak.keycloak_get_admin_realms_realm_identity_provider_instances_alias_export
ParameterTypeRequiredDescription
No parameters.
return_object_stating_whether_client_authorization_permissions_have_been_initialized_or_not_and_reference Read

Return object stating whether client Authorization permissions have been initialized or not and a reference.

Lua path
app.integrations.keycloak.return_object_stating_whether_client_authorization_permissions_have_been_initialized_or_not_and_reference
Full name
keycloak.keycloak_get_admin_realms_realm_identity_provider_instances_alias_management_permissions
ParameterTypeRequiredDescription
No parameters.
get_mapper_types_identity_provider Read

Get mapper types for identity provider.

Lua path
app.integrations.keycloak.get_mapper_types_identity_provider
Full name
keycloak.keycloak_get_admin_realms_realm_identity_provider_instances_alias_mapper_types
ParameterTypeRequiredDescription
No parameters.
get_mappers_identity_provider Read

Get mappers for identity provider.

Lua path
app.integrations.keycloak.get_mappers_identity_provider
Full name
keycloak.keycloak_get_admin_realms_realm_identity_provider_instances_alias_mappers
ParameterTypeRequiredDescription
No parameters.
get_mapper_by_id_identity_provider Read

Get mapper by id for the identity provider.

Lua path
app.integrations.keycloak.get_mapper_by_id_identity_provider
Full name
keycloak.keycloak_get_admin_realms_realm_identity_provider_instances_alias_mappers_id
ParameterTypeRequiredDescription
No parameters.
reaload_identity_provider_if_provider_supports_it_true_is_returned_if_reload_was_performed_false_if_not Read

Reaload keys for the identity provider if the provider supports it, "true" is returned if reload was performed, "false" if not.

Lua path
app.integrations.keycloak.reaload_identity_provider_if_provider_supports_it_true_is_returned_if_reload_was_performed_false_if_not
Full name
keycloak.keycloak_get_admin_realms_realm_identity_provider_instances_alias_reload_keys
ParameterTypeRequiredDescription
No parameters.
get_identity_provider_factory_that_provider_id Read

Get the identity provider factory for that provider id.

Lua path
app.integrations.keycloak.get_identity_provider_factory_that_provider_id
Full name
keycloak.keycloak_get_admin_realms_realm_identity_provider_providers_provider_id
ParameterTypeRequiredDescription
No parameters.
get_admin_realms_realm Read

GET /admin/realms/{realm}/keys.

Lua path
app.integrations.keycloak.get_admin_realms_realm
Full name
keycloak.keycloak_get_admin_realms_realm_keys
ParameterTypeRequiredDescription
No parameters.
get_admin_realms_realm_localization Read

GET /admin/realms/{realm}/localization.

Lua path
app.integrations.keycloak.get_admin_realms_realm_localization
Full name
keycloak.keycloak_get_admin_realms_realm_localization
ParameterTypeRequiredDescription
No parameters.
get_admin_realms_realm_localization_locale Read

GET /admin/realms/{realm}/localization/{locale}.

Lua path
app.integrations.keycloak.get_admin_realms_realm_localization_locale
Full name
keycloak.keycloak_get_admin_realms_realm_localization_locale
ParameterTypeRequiredDescription
No parameters.
get_admin_realms_realm_localization_locale Read

GET /admin/realms/{realm}/localization/{locale}/{key}.

Lua path
app.integrations.keycloak.get_admin_realms_realm_localization_locale
Full name
keycloak.keycloak_get_admin_realms_realm_localization_locale_key
ParameterTypeRequiredDescription
No parameters.
returns_paginated_list_organizations_filtered_according_specified_parameters Read

Returns a paginated list of organizations filtered according to the specified parameters.

Lua path
app.integrations.keycloak.returns_paginated_list_organizations_filtered_according_specified_parameters
Full name
keycloak.keycloak_get_admin_realms_realm_organizations
ParameterTypeRequiredDescription
No parameters.
returns_organizations_counts Read

Returns the organizations counts.

Lua path
app.integrations.keycloak.returns_organizations_counts
Full name
keycloak.keycloak_get_admin_realms_realm_organizations_count
ParameterTypeRequiredDescription
No parameters.
returns_organizations_associated_with_user_that_has_specified_id Read

Returns the organizations associated with the user that has the specified id.

Lua path
app.integrations.keycloak.returns_organizations_associated_with_user_that_has_specified_id
Full name
keycloak.keycloak_get_admin_realms_realm_organizations_members_member_id_organizations
ParameterTypeRequiredDescription
No parameters.
returns_organization_representation Read

Returns the organization representation.

Lua path
app.integrations.keycloak.returns_organization_representation
Full name
keycloak.keycloak_get_admin_realms_realm_organizations_org_id
ParameterTypeRequiredDescription
No parameters.
get_organization_groups Read

Returns organization groups. When `search` parameter is provided, groups are searched by name. When `q` parameter is provided, groups are searched by attributes. If neither parameter is provided, top-level groups are returned.

Lua path
app.integrations.keycloak.get_organization_groups
Full name
keycloak.keycloak_get_admin_realms_realm_organizations_org_id_groups
ParameterTypeRequiredDescription
No parameters.
get_organization_group_by_path Read

Returns the organization group with the specified path

Lua path
app.integrations.keycloak.get_organization_group_by_path
Full name
keycloak.keycloak_get_admin_realms_realm_organizations_org_id_groups_group_by_path_path
ParameterTypeRequiredDescription
No parameters.
get_organization_group_representation Read

Get organization group representation.

Lua path
app.integrations.keycloak.get_organization_group_representation
Full name
keycloak.keycloak_get_admin_realms_realm_organizations_org_id_groups_group_id
ParameterTypeRequiredDescription
No parameters.
get_subgroups_this_organization_group Read

Returns a paginated stream of subgroups that belong to this organization group

Lua path
app.integrations.keycloak.get_subgroups_this_organization_group
Full name
keycloak.keycloak_get_admin_realms_realm_organizations_org_id_groups_group_id_children
ParameterTypeRequiredDescription
No parameters.
get_members_this_organization_group Read

Returns a paginated list of organization members that belong to this group

Lua path
app.integrations.keycloak.get_members_this_organization_group
Full name
keycloak.keycloak_get_admin_realms_realm_organizations_org_id_groups_group_id_members
ParameterTypeRequiredDescription
No parameters.
returns_all_identity_providers_associated_with_organization Read

Returns all identity providers associated with the organization.

Lua path
app.integrations.keycloak.returns_all_identity_providers_associated_with_organization
Full name
keycloak.keycloak_get_admin_realms_realm_organizations_org_id_identity_providers
ParameterTypeRequiredDescription
No parameters.
returns_identity_provider_associated_with_organization_that_has_specified_alias Read

Searches for an identity provider with the given alias. If one is found and is associated with the organization, it is returned. Otherwise, an error response with status NOT_FOUND is returned

Lua path
app.integrations.keycloak.returns_identity_provider_associated_with_organization_that_has_specified_alias
Full name
keycloak.keycloak_get_admin_realms_realm_organizations_org_id_identity_providers_alias
ParameterTypeRequiredDescription
No parameters.
returns_organization_groups_identity_provider Read

Returns organization groups that can be used in identity provider mappers. Only returns groups if the identity provider is associated with the organization.

Lua path
app.integrations.keycloak.returns_organization_groups_identity_provider
Full name
keycloak.keycloak_get_admin_realms_realm_organizations_org_id_identity_providers_alias_groups
ParameterTypeRequiredDescription
No parameters.
get_invitations_organization Read

Get invitations for the organization.

Lua path
app.integrations.keycloak.get_invitations_organization
Full name
keycloak.keycloak_get_admin_realms_realm_organizations_org_id_invitations
ParameterTypeRequiredDescription
No parameters.
get_invitation_by_id Read

Get invitation by ID.

Lua path
app.integrations.keycloak.get_invitation_by_id
Full name
keycloak.keycloak_get_admin_realms_realm_organizations_org_id_invitations_id
ParameterTypeRequiredDescription
No parameters.
returns_paginated_list_organization_members_filtered_according_specified_parameters Read

Returns a paginated list of organization members filtered according to the specified parameters.

Lua path
app.integrations.keycloak.returns_paginated_list_organization_members_filtered_according_specified_parameters
Full name
keycloak.keycloak_get_admin_realms_realm_organizations_org_id_members
ParameterTypeRequiredDescription
No parameters.
returns_number_members_organization Read

Returns number of members in the organization.

Lua path
app.integrations.keycloak.returns_number_members_organization
Full name
keycloak.keycloak_get_admin_realms_realm_organizations_org_id_members_count
ParameterTypeRequiredDescription
No parameters.
returns_member_organization_with_specified_id Read

Searches for auser with the given id. If one is found, and is currently a member of the organization, returns it. Otherwise,an error response with status NOT_FOUND is returned

Lua path
app.integrations.keycloak.returns_member_organization_with_specified_id
Full name
keycloak.keycloak_get_admin_realms_realm_organizations_org_id_members_member_id
ParameterTypeRequiredDescription
No parameters.
returns_organization_group_memberships_member_with_specified_id Read

Searches for auser with the given id. If one is found, and is currently a member of the organization, returns the groups from the organizationwhere the user is member of. Otherwise, an error response with status NOT_FOUND is returned

Lua path
app.integrations.keycloak.returns_organization_group_memberships_member_with_specified_id
Full name
keycloak.keycloak_get_admin_realms_realm_organizations_org_id_members_member_id_groups
ParameterTypeRequiredDescription
No parameters.
returns_organizations_associated_with_user_that_has_specified_id Read

Returns the organizations associated with the user that has the specified id.

Lua path
app.integrations.keycloak.returns_organizations_associated_with_user_that_has_specified_id
Full name
keycloak.keycloak_get_admin_realms_realm_organizations_org_id_members_member_id_organizations
ParameterTypeRequiredDescription
No parameters.
get_all_roles_realm_or_client Read

Get all roles for the realm or client.

Lua path
app.integrations.keycloak.get_all_roles_realm_or_client
Full name
keycloak.keycloak_get_admin_realms_realm_roles
ParameterTypeRequiredDescription
No parameters.
get_specific_role_representation Read

Get a specific role's representation.

Lua path
app.integrations.keycloak.get_specific_role_representation
Full name
keycloak.keycloak_get_admin_realms_realm_roles_by_id_role_id
ParameterTypeRequiredDescription
No parameters.
get_role_children_returns_set_role_children_provided_role_is_composite Read

Get role's children Returns a set of role's children provided the role is a composite.

Lua path
app.integrations.keycloak.get_role_children_returns_set_role_children_provided_role_is_composite
Full name
keycloak.keycloak_get_admin_realms_realm_roles_by_id_role_id_composites
ParameterTypeRequiredDescription
No parameters.
get_client_level_roles_client_that_are_role_composite Read

Get client-level roles for the client that are in the role's composite.

Lua path
app.integrations.keycloak.get_client_level_roles_client_that_are_role_composite
Full name
keycloak.keycloak_get_admin_realms_realm_roles_by_id_role_id_composites_clients_client_uuid
ParameterTypeRequiredDescription
No parameters.
get_realm_level_roles_that_are_role_composite Read

Get realm-level roles that are in the role's composite.

Lua path
app.integrations.keycloak.get_realm_level_roles_that_are_role_composite
Full name
keycloak.keycloak_get_admin_realms_realm_roles_by_id_role_id_composites_realm
ParameterTypeRequiredDescription
No parameters.
return_object_stating_whether_role_authorization_permissions_have_been_initialized_or_not_and_reference Read

Return object stating whether role Authorization permissions have been initialized or not and a reference.

Lua path
app.integrations.keycloak.return_object_stating_whether_role_authorization_permissions_have_been_initialized_or_not_and_reference
Full name
keycloak.keycloak_get_admin_realms_realm_roles_by_id_role_id_management_permissions
ParameterTypeRequiredDescription
No parameters.
get_role_by_name Read

Get a role by name.

Lua path
app.integrations.keycloak.get_role_by_name
Full name
keycloak.keycloak_get_admin_realms_realm_roles_role_name
ParameterTypeRequiredDescription
No parameters.
get_composites_role Read

Get composites of the role.

Lua path
app.integrations.keycloak.get_composites_role
Full name
keycloak.keycloak_get_admin_realms_realm_roles_role_name_composites
ParameterTypeRequiredDescription
No parameters.
get_client_level_roles_client_that_are_role_composite Read

Get client-level roles for the client that are in the role's composite.

Lua path
app.integrations.keycloak.get_client_level_roles_client_that_are_role_composite
Full name
keycloak.keycloak_get_admin_realms_realm_roles_role_name_composites_clients_target_client_uuid
ParameterTypeRequiredDescription
No parameters.
get_realm_level_roles_role_composite Read

Get realm-level roles of the role's composite.

Lua path
app.integrations.keycloak.get_realm_level_roles_role_composite
Full name
keycloak.keycloak_get_admin_realms_realm_roles_role_name_composites_realm
ParameterTypeRequiredDescription
No parameters.
returns_stream_groups_that_have_specified_role_name Read

Returns a stream of groups that have the specified role name.

Lua path
app.integrations.keycloak.returns_stream_groups_that_have_specified_role_name
Full name
keycloak.keycloak_get_admin_realms_realm_roles_role_name_groups
ParameterTypeRequiredDescription
No parameters.
return_object_stating_whether_role_authorization_permissions_have_been_initialized_or_not_and_reference Read

Return object stating whether role Authorization permissions have been initialized or not and a reference.

Lua path
app.integrations.keycloak.return_object_stating_whether_role_authorization_permissions_have_been_initialized_or_not_and_reference
Full name
keycloak.keycloak_get_admin_realms_realm_roles_role_name_management_permissions
ParameterTypeRequiredDescription
No parameters.
returns_stream_users_that_have_specified_role_name Read

Returns a stream of users that have the specified role name.

Lua path
app.integrations.keycloak.returns_stream_users_that_have_specified_role_name
Full name
keycloak.keycloak_get_admin_realms_realm_roles_role_name_users
ParameterTypeRequiredDescription
No parameters.
get_users_returns_stream_users_filtered_according_query_parameters Read

Returns a stream of users. Note that the 'credentials' field in the returned UserRepresentation objects is typically not populated for performance reasons. If specific credential metadata is required, use the dedicated 'GET /admin/realms/{realm}/users/{user-id}/credentials' endpoint.

Lua path
app.integrations.keycloak.get_users_returns_stream_users_filtered_according_query_parameters
Full name
keycloak.keycloak_get_admin_realms_realm_users
ParameterTypeRequiredDescription
No parameters.
returns_number_users_that_match_given_criteria Read

It can be called in three different ways. 1. Don’t specify any criteria and pass {@code null}. The number of all users within that realm will be returned. 2. If {@code search} is specified other criteria such as {@code last} will be ignored even though you set them. The {@code search} string will be matched against the first and last name, the username and the email of a user. 3. If {@code search} is unspecified but any of {@code last}, {@code first}, {@code email} or {@code username} those crit

Lua path
app.integrations.keycloak.returns_number_users_that_match_given_criteria
Full name
keycloak.keycloak_get_admin_realms_realm_users_count
ParameterTypeRequiredDescription
No parameters.
get_admin_realms_realm_users_management_permissions Read

GET /admin/realms/{realm}/users-management-permissions.

Lua path
app.integrations.keycloak.get_admin_realms_realm_users_management_permissions
Full name
keycloak.keycloak_get_admin_realms_realm_users_management_permissions
ParameterTypeRequiredDescription
No parameters.
get_admin_realms_realm_users_profile Read

Get the configuration for the user profile

Lua path
app.integrations.keycloak.get_admin_realms_realm_users_profile
Full name
keycloak.keycloak_get_admin_realms_realm_users_profile
ParameterTypeRequiredDescription
No parameters.
get_admin_realms_realm_users_profile_metadata Read

Get the UserProfileMetadata from the configuration

Lua path
app.integrations.keycloak.get_admin_realms_realm_users_profile_metadata
Full name
keycloak.keycloak_get_admin_realms_realm_users_profile_metadata
ParameterTypeRequiredDescription
No parameters.
get_representation_user Read

Get representation of the user.

Lua path
app.integrations.keycloak.get_representation_user
Full name
keycloak.keycloak_get_admin_realms_realm_users_user_id
ParameterTypeRequiredDescription
No parameters.
return_credential_types_which_are_provided_by_user_storage_where_user_is_stored Read

Returned values can contain for example "password", "otp" etc. This will always return empty list for "local" users, which are not backed by any user storage

Lua path
app.integrations.keycloak.return_credential_types_which_are_provided_by_user_storage_where_user_is_stored
Full name
keycloak.keycloak_get_admin_realms_realm_users_user_id_configured_user_storage_credential_types
ParameterTypeRequiredDescription
No parameters.
get_consents_granted_by_user Read

Get consents granted by the user.

Lua path
app.integrations.keycloak.get_consents_granted_by_user
Full name
keycloak.keycloak_get_admin_realms_realm_users_user_id_consents
ParameterTypeRequiredDescription
No parameters.
get_admin_realms_realm_users_user_id_credentials Read

GET /admin/realms/{realm}/users/{user-id}/credentials.

Lua path
app.integrations.keycloak.get_admin_realms_realm_users_user_id_credentials
Full name
keycloak.keycloak_get_admin_realms_realm_users_user_id_credentials
ParameterTypeRequiredDescription
No parameters.
get_social_logins_associated_with_user Read

Get social logins associated with the user.

Lua path
app.integrations.keycloak.get_social_logins_associated_with_user
Full name
keycloak.keycloak_get_admin_realms_realm_users_user_id_federated_identity
ParameterTypeRequiredDescription
No parameters.
get_admin_realms_realm_users_user_id_groups Read

GET /admin/realms/{realm}/users/{user-id}/groups.

Lua path
app.integrations.keycloak.get_admin_realms_realm_users_user_id_groups
Full name
keycloak.keycloak_get_admin_realms_realm_users_user_id_groups
ParameterTypeRequiredDescription
No parameters.
get_admin_realms_realm_users_user_id_groups_count Read

GET /admin/realms/{realm}/users/{user-id}/groups/count.

Lua path
app.integrations.keycloak.get_admin_realms_realm_users_user_id_groups_count
Full name
keycloak.keycloak_get_admin_realms_realm_users_user_id_groups_count
ParameterTypeRequiredDescription
No parameters.
get_offline_sessions_associated_with_user_and_client Read

Get offline sessions associated with the user and client.

Lua path
app.integrations.keycloak.get_offline_sessions_associated_with_user_and_client
Full name
keycloak.keycloak_get_admin_realms_realm_users_user_id_offline_sessions_client_uuid
ParameterTypeRequiredDescription
No parameters.
get_role_mappings Read

Get role mappings.

Lua path
app.integrations.keycloak.get_role_mappings
Full name
keycloak.keycloak_get_admin_realms_realm_users_user_id_role_mappings
ParameterTypeRequiredDescription
No parameters.
get_client_level_role_mappings_user_or_group_and_app Read

Get client-level role mappings for the user or group, and the app.

Lua path
app.integrations.keycloak.get_client_level_role_mappings_user_or_group_and_app
Full name
keycloak.keycloak_get_admin_realms_realm_users_user_id_role_mappings_clients_client_id
ParameterTypeRequiredDescription
No parameters.
get_available_client_level_roles_that_can_be_mapped_user_or_group Read

Get available client-level roles that can be mapped to the user or group.

Lua path
app.integrations.keycloak.get_available_client_level_roles_that_can_be_mapped_user_or_group
Full name
keycloak.keycloak_get_admin_realms_realm_users_user_id_role_mappings_clients_client_id_available
ParameterTypeRequiredDescription
No parameters.
get_effective_client_level_role_mappings_this_recurses_any_composite_roles Read

Get effective client-level role mappings This recurses any composite roles.

Lua path
app.integrations.keycloak.get_effective_client_level_role_mappings_this_recurses_any_composite_roles
Full name
keycloak.keycloak_get_admin_realms_realm_users_user_id_role_mappings_clients_client_id_composite
ParameterTypeRequiredDescription
No parameters.
get_realm_level_role_mappings Read

Get realm-level role mappings.

Lua path
app.integrations.keycloak.get_realm_level_role_mappings
Full name
keycloak.keycloak_get_admin_realms_realm_users_user_id_role_mappings_realm
ParameterTypeRequiredDescription
No parameters.
get_realm_level_roles_that_can_be_mapped Read

Get realm-level roles that can be mapped.

Lua path
app.integrations.keycloak.get_realm_level_roles_that_can_be_mapped
Full name
keycloak.keycloak_get_admin_realms_realm_users_user_id_role_mappings_realm_available
ParameterTypeRequiredDescription
No parameters.
get_effective_realm_level_role_mappings_this_will_recurse_all_composite_roles_get_result Read

Get effective realm-level role mappings This will recurse all composite roles to get the result.

Lua path
app.integrations.keycloak.get_effective_realm_level_role_mappings_this_will_recurse_all_composite_roles_get_result
Full name
keycloak.keycloak_get_admin_realms_realm_users_user_id_role_mappings_realm_composite
ParameterTypeRequiredDescription
No parameters.
get_sessions_associated_with_user Read

Get sessions associated with the user.

Lua path
app.integrations.keycloak.get_sessions_associated_with_user
Full name
keycloak.keycloak_get_admin_realms_realm_users_user_id_sessions
ParameterTypeRequiredDescription
No parameters.
get_admin_realms_realm_users_user_id_unmanagedattributes Read

GET /admin/realms/{realm}/users/{user-id}/unmanagedAttributes.

Lua path
app.integrations.keycloak.get_admin_realms_realm_users_user_id_unmanagedattributes
Full name
keycloak.keycloak_get_admin_realms_realm_users_user_id_unmanaged_attributes
ParameterTypeRequiredDescription
No parameters.
list_workflows Read

List workflows filtered by name and paginated using first and max parameters.

Lua path
app.integrations.keycloak.list_workflows
Full name
keycloak.keycloak_get_admin_realms_realm_workflows
ParameterTypeRequiredDescription
No parameters.
get_workflow Read

Get the workflow representation. Optionally exclude the workflow id from the response.

Lua path
app.integrations.keycloak.get_workflow
Full name
keycloak.keycloak_get_admin_realms_realm_workflows_id
ParameterTypeRequiredDescription
No parameters.
list_scheduled_workflows_resource Read

Return workflows that have scheduled steps for the given resource identifier.

Lua path
app.integrations.keycloak.list_scheduled_workflows_resource
Full name
keycloak.keycloak_get_admin_realms_realm_workflows_scheduled_resource_id
ParameterTypeRequiredDescription
No parameters.
import_realm_imports_realm_from_full_representation_that_realm Write

Realm name must be unique.

Lua path
app.integrations.keycloak.import_realm_imports_realm_from_full_representation_that_realm
Full name
keycloak.keycloak_post_admin_realms
ParameterTypeRequiredDescription
No parameters.
create_new_authenticator_configuration Write

Create new authenticator configuration.

Lua path
app.integrations.keycloak.create_new_authenticator_configuration
Full name
keycloak.keycloak_post_admin_realms_realm_authentication_config
ParameterTypeRequiredDescription
No parameters.
add_new_authentication_execution Write

Add new authentication execution.

Lua path
app.integrations.keycloak.add_new_authentication_execution
Full name
keycloak.keycloak_post_admin_realms_realm_authentication_executions
ParameterTypeRequiredDescription
No parameters.
update_execution_with_new_configuration Write

Update execution with new configuration.

Lua path
app.integrations.keycloak.update_execution_with_new_configuration
Full name
keycloak.keycloak_post_admin_realms_realm_authentication_executions_execution_id_config
ParameterTypeRequiredDescription
No parameters.
lower_execution_priority Write

Lower execution's priority.

Lua path
app.integrations.keycloak.lower_execution_priority
Full name
keycloak.keycloak_post_admin_realms_realm_authentication_executions_execution_id_lower_priority
ParameterTypeRequiredDescription
No parameters.
raise_execution_priority Write

Raise execution's priority.

Lua path
app.integrations.keycloak.raise_execution_priority
Full name
keycloak.keycloak_post_admin_realms_realm_authentication_executions_execution_id_raise_priority
ParameterTypeRequiredDescription
No parameters.
create_new_authentication_flow Write

Create a new authentication flow.

Lua path
app.integrations.keycloak.create_new_authentication_flow
Full name
keycloak.keycloak_post_admin_realms_realm_authentication_flows
ParameterTypeRequiredDescription
No parameters.
copy_existing_authentication_flow_under_new_name_new_name_is_given_newname_attribute_passed_json_object Write

Copy existing authentication flow under a new name The new name is given as 'newName' attribute of the passed JSON object.

Lua path
app.integrations.keycloak.copy_existing_authentication_flow_under_new_name_new_name_is_given_newname_attribute_passed_json_object
Full name
keycloak.keycloak_post_admin_realms_realm_authentication_flows_flow_alias_copy
ParameterTypeRequiredDescription
No parameters.
add_new_authentication_execution_flow Write

Add new authentication execution to a flow.

Lua path
app.integrations.keycloak.add_new_authentication_execution_flow
Full name
keycloak.keycloak_post_admin_realms_realm_authentication_flows_flow_alias_executions_execution
ParameterTypeRequiredDescription
No parameters.
add_new_flow_with_new_execution_existing_flow Write

Add new flow with new execution to existing flow.

Lua path
app.integrations.keycloak.add_new_flow_with_new_execution_existing_flow
Full name
keycloak.keycloak_post_admin_realms_realm_authentication_flows_flow_alias_executions_flow
ParameterTypeRequiredDescription
No parameters.
register_new_required_actions Write

Register a new required actions.

Lua path
app.integrations.keycloak.register_new_required_actions
Full name
keycloak.keycloak_post_admin_realms_realm_authentication_register_required_action
ParameterTypeRequiredDescription
No parameters.
lower_required_action_priority Write

Lower required action's priority.

Lua path
app.integrations.keycloak.lower_required_action_priority
Full name
keycloak.keycloak_post_admin_realms_realm_authentication_required_actions_alias_lower_priority
ParameterTypeRequiredDescription
No parameters.
raise_required_action_priority Write

Raise required action's priority.

Lua path
app.integrations.keycloak.raise_required_action_priority
Full name
keycloak.keycloak_post_admin_realms_realm_authentication_required_actions_alias_raise_priority
ParameterTypeRequiredDescription
No parameters.
base_path_importing_clients_under_this_realm Write

Base path for importing clients under this realm.

Lua path
app.integrations.keycloak.base_path_importing_clients_under_this_realm
Full name
keycloak.keycloak_post_admin_realms_realm_client_description_converter
ParameterTypeRequiredDescription
No parameters.
create_new_client_scope_client_scope_name_must_be_unique Write

Create a new client scope Client Scope’s name must be unique!.

Lua path
app.integrations.keycloak.create_new_client_scope_client_scope_name_must_be_unique
Full name
keycloak.keycloak_post_admin_realms_realm_client_scopes
ParameterTypeRequiredDescription
No parameters.
create_multiple_mappers Write

Create multiple mappers.

Lua path
app.integrations.keycloak.create_multiple_mappers
Full name
keycloak.keycloak_post_admin_realms_realm_client_scopes_client_scope_id_protocol_mappers_add_models
ParameterTypeRequiredDescription
No parameters.
create_mapper Write

Create a mapper.

Lua path
app.integrations.keycloak.create_mapper
Full name
keycloak.keycloak_post_admin_realms_realm_client_scopes_client_scope_id_protocol_mappers_models
ParameterTypeRequiredDescription
No parameters.
add_client_level_roles_client_scope Write

Add client-level roles to the client's scope.

Lua path
app.integrations.keycloak.add_client_level_roles_client_scope
Full name
keycloak.keycloak_post_admin_realms_realm_client_scopes_client_scope_id_scope_mappings_clients_client
ParameterTypeRequiredDescription
No parameters.
add_set_realm_level_roles_client_scope Write

Add a set of realm-level roles to the client's scope.

Lua path
app.integrations.keycloak.add_set_realm_level_roles_client_scope
Full name
keycloak.keycloak_post_admin_realms_realm_client_scopes_client_scope_id_scope_mappings_realm
ParameterTypeRequiredDescription
No parameters.
create_new_client_scope_client_scope_name_must_be_unique Write

Create a new client scope Client Scope’s name must be unique!.

Lua path
app.integrations.keycloak.create_new_client_scope_client_scope_name_must_be_unique
Full name
keycloak.keycloak_post_admin_realms_realm_client_templates
ParameterTypeRequiredDescription
No parameters.
create_multiple_mappers Write

Create multiple mappers.

Lua path
app.integrations.keycloak.create_multiple_mappers
Full name
keycloak.keycloak_post_admin_realms_realm_client_templates_client_scope_id_protocol_mappers_add_models
ParameterTypeRequiredDescription
No parameters.
create_mapper Write

Create a mapper.

Lua path
app.integrations.keycloak.create_mapper
Full name
keycloak.keycloak_post_admin_realms_realm_client_templates_client_scope_id_protocol_mappers_models
ParameterTypeRequiredDescription
No parameters.
add_client_level_roles_client_scope Write

Add client-level roles to the client's scope.

Lua path
app.integrations.keycloak.add_client_level_roles_client_scope
Full name
keycloak.keycloak_post_admin_realms_realm_client_templates_client_scope_id_scope_mappings_clients_client
ParameterTypeRequiredDescription
No parameters.
add_set_realm_level_roles_client_scope Write

Add a set of realm-level roles to the client's scope.

Lua path
app.integrations.keycloak.add_set_realm_level_roles_client_scope
Full name
keycloak.keycloak_post_admin_realms_realm_client_templates_client_scope_id_scope_mappings_realm
ParameterTypeRequiredDescription
No parameters.
create_new_client_client_client_id_must_be_unique Write

Create a new client Client’s client_id must be unique!.

Lua path
app.integrations.keycloak.create_new_client_client_client_id_must_be_unique
Full name
keycloak.keycloak_post_admin_realms_realm_clients
ParameterTypeRequiredDescription
No parameters.
post_admin_realms_realm_clients_client_uuid_authz_resource_server_import Write

POST /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/import.

Lua path
app.integrations.keycloak.post_admin_realms_realm_clients_client_uuid_authz_resource_server_import
Full name
keycloak.keycloak_post_admin_realms_realm_clients_client_uuid_authz_resource_server_import
ParameterTypeRequiredDescription
No parameters.
post_admin_realms_realm_clients_client_uuid_authz_resource_server_permission Write

POST /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/permission.

Lua path
app.integrations.keycloak.post_admin_realms_realm_clients_client_uuid_authz_resource_server_permission
Full name
keycloak.keycloak_post_admin_realms_realm_clients_client_uuid_authz_resource_server_permission
ParameterTypeRequiredDescription
No parameters.
post_admin_realms_realm_clients_client_uuid_authz_resource_server_permission_evaluate Write

POST /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/permission/evaluate.

Lua path
app.integrations.keycloak.post_admin_realms_realm_clients_client_uuid_authz_resource_server_permission_evaluate
Full name
keycloak.keycloak_post_admin_realms_realm_clients_client_uuid_authz_resource_server_permission_evaluate
ParameterTypeRequiredDescription
No parameters.
post_admin_realms_realm_clients_client_uuid_authz_resource_server_policy Write

POST /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/policy.

Lua path
app.integrations.keycloak.post_admin_realms_realm_clients_client_uuid_authz_resource_server_policy
Full name
keycloak.keycloak_post_admin_realms_realm_clients_client_uuid_authz_resource_server_policy
ParameterTypeRequiredDescription
No parameters.
post_admin_realms_realm_clients_client_uuid_authz_resource_server_policy_evaluate Write

POST /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/policy/evaluate.

Lua path
app.integrations.keycloak.post_admin_realms_realm_clients_client_uuid_authz_resource_server_policy_evaluate
Full name
keycloak.keycloak_post_admin_realms_realm_clients_client_uuid_authz_resource_server_policy_evaluate
ParameterTypeRequiredDescription
No parameters.
post_admin_realms_realm_clients_client_uuid_authz_resource_server_resource Write

POST /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/resource.

Lua path
app.integrations.keycloak.post_admin_realms_realm_clients_client_uuid_authz_resource_server_resource
Full name
keycloak.keycloak_post_admin_realms_realm_clients_client_uuid_authz_resource_server_resource
ParameterTypeRequiredDescription
No parameters.
post_admin_realms_realm_clients_client_uuid_authz_resource_server_scope Write

POST /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/scope.

Lua path
app.integrations.keycloak.post_admin_realms_realm_clients_client_uuid_authz_resource_server_scope
Full name
keycloak.keycloak_post_admin_realms_realm_clients_client_uuid_authz_resource_server_scope
ParameterTypeRequiredDescription
No parameters.
get_keystore_file_client_containing_private_and_public_certificate Write

Get a keystore file for the client, containing private key and public certificate.

Lua path
app.integrations.keycloak.get_keystore_file_client_containing_private_and_public_certificate
Full name
keycloak.keycloak_post_admin_realms_realm_clients_client_uuid_certificates_attr_download
ParameterTypeRequiredDescription
No parameters.
generate_new_certificate_with_new_pair Write

Generate a new certificate with new key pair.

Lua path
app.integrations.keycloak.generate_new_certificate_with_new_pair
Full name
keycloak.keycloak_post_admin_realms_realm_clients_client_uuid_certificates_attr_generate
ParameterTypeRequiredDescription
No parameters.
generate_new_keypair_and_certificate_and_get_private_file_generates_keypair_and_certificate_and_serves_private_specified_keystore_format_only_generated_public_certificate_is_saved_db_private_is_not Write

Generate a new keypair and certificate, and get the private key file Generates a keypair and certificate and serves the private key in a specified keystore format. Only generated public certificate is saved in Keycloak DB - the private key is not.

Lua path
app.integrations.keycloak.generate_new_keypair_and_certificate_and_get_private_file_generates_keypair_and_certificate_and_serves_private_specified_keystore_format_only_generated_public_certificate_is_saved_db_private_is_not
Full name
keycloak.keycloak_post_admin_realms_realm_clients_client_uuid_certificates_attr_generate_and_download
ParameterTypeRequiredDescription
No parameters.
upload_certificate_and_eventually_private Write

Upload certificate and eventually private key.

Lua path
app.integrations.keycloak.upload_certificate_and_eventually_private
Full name
keycloak.keycloak_post_admin_realms_realm_clients_client_uuid_certificates_attr_upload
ParameterTypeRequiredDescription
No parameters.
upload_only_certificate_not_private Write

Upload only certificate, not private key.

Lua path
app.integrations.keycloak.upload_only_certificate_not_private
Full name
keycloak.keycloak_post_admin_realms_realm_clients_client_uuid_certificates_attr_upload_certificate
ParameterTypeRequiredDescription
No parameters.
generate_new_secret_client Write

Generate a new secret for the client.

Lua path
app.integrations.keycloak.generate_new_secret_client
Full name
keycloak.keycloak_post_admin_realms_realm_clients_client_uuid_client_secret
ParameterTypeRequiredDescription
No parameters.
register_cluster_node_with_client_manually_register_cluster_node_this_client_usually_it_not_needed_call_this_directly_adapter_should_handle_by_sending_registration_request Write

Register a cluster node with the client Manually register cluster node to this client - usually it’s not needed to call this directly as adapter should handle by sending registration request to Keycloak.

Lua path
app.integrations.keycloak.register_cluster_node_with_client_manually_register_cluster_node_this_client_usually_it_not_needed_call_this_directly_adapter_should_handle_by_sending_registration_request
Full name
keycloak.keycloak_post_admin_realms_realm_clients_client_uuid_nodes
ParameterTypeRequiredDescription
No parameters.
create_multiple_mappers Write

Create multiple mappers.

Lua path
app.integrations.keycloak.create_multiple_mappers
Full name
keycloak.keycloak_post_admin_realms_realm_clients_client_uuid_protocol_mappers_add_models
ParameterTypeRequiredDescription
No parameters.
create_mapper Write

Create a mapper.

Lua path
app.integrations.keycloak.create_mapper
Full name
keycloak.keycloak_post_admin_realms_realm_clients_client_uuid_protocol_mappers_models
ParameterTypeRequiredDescription
No parameters.
push_client_revocation_policy_its_admin_url_if_client_has_admin_url_push_revocation_policy_it Write

Push the client's revocation policy to its admin URL If the client has an admin URL, push revocation policy to it.

Lua path
app.integrations.keycloak.push_client_revocation_policy_its_admin_url_if_client_has_admin_url_push_revocation_policy_it
Full name
keycloak.keycloak_post_admin_realms_realm_clients_client_uuid_push_revocation
ParameterTypeRequiredDescription
No parameters.
generate_new_registration_access_token_client Write

Generate a new registration access token for the client.

Lua path
app.integrations.keycloak.generate_new_registration_access_token_client
Full name
keycloak.keycloak_post_admin_realms_realm_clients_client_uuid_registration_access_token
ParameterTypeRequiredDescription
No parameters.
create_new_role_realm_or_client Write

Create a new role for the realm or client.

Lua path
app.integrations.keycloak.create_new_role_realm_or_client
Full name
keycloak.keycloak_post_admin_realms_realm_clients_client_uuid_roles
ParameterTypeRequiredDescription
No parameters.
add_composite_role Write

Add a composite to the role.

Lua path
app.integrations.keycloak.add_composite_role
Full name
keycloak.keycloak_post_admin_realms_realm_clients_client_uuid_roles_role_name_composites
ParameterTypeRequiredDescription
No parameters.
add_client_level_roles_client_scope Write

Add client-level roles to the client's scope.

Lua path
app.integrations.keycloak.add_client_level_roles_client_scope
Full name
keycloak.keycloak_post_admin_realms_realm_clients_client_uuid_scope_mappings_clients_client
ParameterTypeRequiredDescription
No parameters.
add_set_realm_level_roles_client_scope Write

Add a set of realm-level roles to the client's scope.

Lua path
app.integrations.keycloak.add_set_realm_level_roles_client_scope
Full name
keycloak.keycloak_post_admin_realms_realm_clients_client_uuid_scope_mappings_realm
ParameterTypeRequiredDescription
No parameters.
create_new_initial_access_token Write

Create a new initial access token.

Lua path
app.integrations.keycloak.create_new_initial_access_token
Full name
keycloak.keycloak_post_admin_realms_realm_clients_initial_access
ParameterTypeRequiredDescription
No parameters.
post_admin_realms_realm_components Write

POST /admin/realms/{realm}/components.

Lua path
app.integrations.keycloak.post_admin_realms_realm_components
Full name
keycloak.keycloak_post_admin_realms_realm_components
ParameterTypeRequiredDescription
No parameters.
create_or_add_top_level_realm_groupset_or_create_child Write

This will update the group and set the parent if it exists. Create it and set the parent if the group doesn’t exist.

Lua path
app.integrations.keycloak.create_or_add_top_level_realm_groupset_or_create_child
Full name
keycloak.keycloak_post_admin_realms_realm_groups
ParameterTypeRequiredDescription
No parameters.
set_or_create_child Write

This will just set the parent if it exists. Create it and set the parent if the group doesn’t exist.

Lua path
app.integrations.keycloak.set_or_create_child
Full name
keycloak.keycloak_post_admin_realms_realm_groups_group_id_children
ParameterTypeRequiredDescription
No parameters.
add_client_level_roles_user_or_group_role_mapping Write

Add client-level roles to the user or group role mapping.

Lua path
app.integrations.keycloak.add_client_level_roles_user_or_group_role_mapping
Full name
keycloak.keycloak_post_admin_realms_realm_groups_group_id_role_mappings_clients_client_id
ParameterTypeRequiredDescription
No parameters.
add_realm_level_role_mappings_user Write

Add realm-level role mappings to the user.

Lua path
app.integrations.keycloak.add_realm_level_role_mappings_user
Full name
keycloak.keycloak_post_admin_realms_realm_groups_group_id_role_mappings_realm
ParameterTypeRequiredDescription
No parameters.
import_identity_provider_from_json_body Write

Import identity provider from uploaded JSON file

Lua path
app.integrations.keycloak.import_identity_provider_from_json_body
Full name
keycloak.keycloak_post_admin_realms_realm_identity_provider_import_config
ParameterTypeRequiredDescription
No parameters.
create_new_identity_provider Write

Create a new identity provider.

Lua path
app.integrations.keycloak.create_new_identity_provider
Full name
keycloak.keycloak_post_admin_realms_realm_identity_provider_instances
ParameterTypeRequiredDescription
No parameters.
add_mapper_identity_provider Write

Add a mapper to identity provider.

Lua path
app.integrations.keycloak.add_mapper_identity_provider
Full name
keycloak.keycloak_post_admin_realms_realm_identity_provider_instances_alias_mappers
ParameterTypeRequiredDescription
No parameters.
uploads_certificate_prepares_jwks_or_public_associated_and_returns_certificate_representation Write

Uploads a certificate, prepares the jwks or public key associated, and returns the certificate representation.

Lua path
app.integrations.keycloak.uploads_certificate_prepares_jwks_or_public_associated_and_returns_certificate_representation
Full name
keycloak.keycloak_post_admin_realms_realm_identity_provider_upload_certificate
ParameterTypeRequiredDescription
No parameters.
import_localization_from_uploaded_json_file Write

Import localization from uploaded JSON file.

Lua path
app.integrations.keycloak.import_localization_from_uploaded_json_file
Full name
keycloak.keycloak_post_admin_realms_realm_localization_locale
ParameterTypeRequiredDescription
No parameters.
removes_all_user_sessions Write

Any client that has an admin url will also be told to invalidate any sessions they have.

Lua path
app.integrations.keycloak.removes_all_user_sessions
Full name
keycloak.keycloak_post_admin_realms_realm_logout_all
ParameterTypeRequiredDescription
No parameters.
creates_new_organization Write

Creates a new organization.

Lua path
app.integrations.keycloak.creates_new_organization
Full name
keycloak.keycloak_post_admin_realms_realm_organizations
ParameterTypeRequiredDescription
No parameters.
creates_new_top_level_group_or_moves_existing_group_top_level Write

Creates a new top-level group in the organization. If the group representation includes an ID, moves the existing organization group to be a top-level group. If no ID is provided, creates a new top-level group.

Lua path
app.integrations.keycloak.creates_new_top_level_group_or_moves_existing_group_top_level
Full name
keycloak.keycloak_post_admin_realms_realm_organizations_org_id_groups
ParameterTypeRequiredDescription
No parameters.
create_or_move_subgroup Write

Creates a new subgroup under this organization group. If the group representation includes an ID, moves the existing group to be a child of this group. If no ID is provided, creates a new subgroup.

Lua path
app.integrations.keycloak.create_or_move_subgroup
Full name
keycloak.keycloak_post_admin_realms_realm_organizations_org_id_groups_group_id_children
ParameterTypeRequiredDescription
No parameters.
adds_identity_provider_with_specified_id_organization Write

Adds, or associates, an existing identity provider with the organization. If no identity provider is found, or if it is already associated with the organization, an error response is returned

Lua path
app.integrations.keycloak.adds_identity_provider_with_specified_id_organization
Full name
keycloak.keycloak_post_admin_realms_realm_organizations_org_id_identity_providers
ParameterTypeRequiredDescription
No parameters.
resend_invitation Write

Resend an invitation.

Lua path
app.integrations.keycloak.resend_invitation
Full name
keycloak.keycloak_post_admin_realms_realm_organizations_org_id_invitations_id_resend
ParameterTypeRequiredDescription
No parameters.
adds_user_with_specified_id_member_organization Write

Adds, or associates, an existing user with the organization. If no user is found, or if it is already associated with the organization, an error response is returned

Lua path
app.integrations.keycloak.adds_user_with_specified_id_member_organization
Full name
keycloak.keycloak_post_admin_realms_realm_organizations_org_id_members
ParameterTypeRequiredDescription
No parameters.
invites_existing_user_organization_using_specified_user_id Write

Invites an existing user to the organization, using the specified user id.

Lua path
app.integrations.keycloak.invites_existing_user_organization_using_specified_user_id
Full name
keycloak.keycloak_post_admin_realms_realm_organizations_org_id_members_invite_existing_user
ParameterTypeRequiredDescription
No parameters.
partial_export_existing_realm_into_json_file Write

Partial export of existing realm into a JSON file.

Lua path
app.integrations.keycloak.partial_export_existing_realm_into_json_file
Full name
keycloak.keycloak_post_admin_realms_realm_partial_export
ParameterTypeRequiredDescription
No parameters.
partial_import_from_json_file_existing_realm Write

Partial import from a JSON file to an existing realm.

Lua path
app.integrations.keycloak.partial_import_from_json_file_existing_realm
Full name
keycloak.keycloak_post_admin_realms_realm_partial_import
ParameterTypeRequiredDescription
No parameters.
push_realm_revocation_policy_any_client_that_has_admin_url_associated_with_it Write

Push the realm's revocation policy to any client that has an admin url associated with it.

Lua path
app.integrations.keycloak.push_realm_revocation_policy_any_client_that_has_admin_url_associated_with_it
Full name
keycloak.keycloak_post_admin_realms_realm_push_revocation
ParameterTypeRequiredDescription
No parameters.
create_new_role_realm_or_client Write

Create a new role for the realm or client.

Lua path
app.integrations.keycloak.create_new_role_realm_or_client
Full name
keycloak.keycloak_post_admin_realms_realm_roles
ParameterTypeRequiredDescription
No parameters.
make_role_composite_role_by_associating_some_child_roles Write

Make the role a composite role by associating some child roles.

Lua path
app.integrations.keycloak.make_role_composite_role_by_associating_some_child_roles
Full name
keycloak.keycloak_post_admin_realms_realm_roles_by_id_role_id_composites
ParameterTypeRequiredDescription
No parameters.
add_composite_role Write

Add a composite to the role.

Lua path
app.integrations.keycloak.add_composite_role
Full name
keycloak.keycloak_post_admin_realms_realm_roles_role_name_composites
ParameterTypeRequiredDescription
No parameters.
test_smtp_connection_with_current_logged_user Write

Test SMTP connection with current logged in user.

Lua path
app.integrations.keycloak.test_smtp_connection_with_current_logged_user
Full name
keycloak.keycloak_post_admin_realms_realm_test_smtpconnection
ParameterTypeRequiredDescription
No parameters.
create_new_user_username_must_be_unique Write

Create a new user Username must be unique.

Lua path
app.integrations.keycloak.create_new_user_username_must_be_unique
Full name
keycloak.keycloak_post_admin_realms_realm_users
ParameterTypeRequiredDescription
No parameters.
move_credential_position_behind_another_credential Write

Move a credential to a position behind another credential.

Lua path
app.integrations.keycloak.move_credential_position_behind_another_credential
Full name
keycloak.keycloak_post_admin_realms_realm_users_user_id_credentials_credential_id_move_after_new_previous_credential_id
ParameterTypeRequiredDescription
No parameters.
move_credential_first_position_credentials_list_user Write

Move a credential to a first position in the credentials list of the user.

Lua path
app.integrations.keycloak.move_credential_first_position_credentials_list_user
Full name
keycloak.keycloak_post_admin_realms_realm_users_user_id_credentials_credential_id_move_to_first
ParameterTypeRequiredDescription
No parameters.
add_social_login_provider_user Write

Add a social login provider to the user.

Lua path
app.integrations.keycloak.add_social_login_provider_user
Full name
keycloak.keycloak_post_admin_realms_realm_users_user_id_federated_identity_provider
ParameterTypeRequiredDescription
No parameters.
impersonate_user Write

Impersonate the user.

Lua path
app.integrations.keycloak.impersonate_user
Full name
keycloak.keycloak_post_admin_realms_realm_users_user_id_impersonation
ParameterTypeRequiredDescription
No parameters.
remove_all_user_sessions_associated_with_user_also_send_notification_all_clients_that_have_admin_url_invalidate_sessions_particular_user Write

Remove all user sessions associated with the user Also send notification to all clients that have an admin URL to invalidate the sessions for the particular user.

Lua path
app.integrations.keycloak.remove_all_user_sessions_associated_with_user_also_send_notification_all_clients_that_have_admin_url_invalidate_sessions_particular_user
Full name
keycloak.keycloak_post_admin_realms_realm_users_user_id_logout
ParameterTypeRequiredDescription
No parameters.
add_client_level_roles_user_or_group_role_mapping Write

Add client-level roles to the user or group role mapping.

Lua path
app.integrations.keycloak.add_client_level_roles_user_or_group_role_mapping
Full name
keycloak.keycloak_post_admin_realms_realm_users_user_id_role_mappings_clients_client_id
ParameterTypeRequiredDescription
No parameters.
add_realm_level_role_mappings_user Write

Add realm-level role mappings to the user.

Lua path
app.integrations.keycloak.add_realm_level_role_mappings_user
Full name
keycloak.keycloak_post_admin_realms_realm_users_user_id_role_mappings_realm
ParameterTypeRequiredDescription
No parameters.
create_workflow Write

Create a new workflow from the provided representation.

Lua path
app.integrations.keycloak.create_workflow
Full name
keycloak.keycloak_post_admin_realms_realm_workflows
ParameterTypeRequiredDescription
No parameters.
activate_workflow_resource Write

Activate the workflow for the given resource type and identifier. Optionally schedule the first step using the notBefore parameter.

Lua path
app.integrations.keycloak.activate_workflow_resource
Full name
keycloak.keycloak_post_admin_realms_realm_workflows_id_activate_type_resource_id
ParameterTypeRequiredDescription
No parameters.
deactivate_workflow_resource Write

Deactivate the workflow for the given resource type and identifier.

Lua path
app.integrations.keycloak.deactivate_workflow_resource
Full name
keycloak.keycloak_post_admin_realms_realm_workflows_id_deactivate_type_resource_id
ParameterTypeRequiredDescription
No parameters.
migrate_scheduled_resources_from_one_step_another Write

Migrate scheduled resources from one step to another step in the same or in a different workflow.

Lua path
app.integrations.keycloak.migrate_scheduled_resources_from_one_step_another
Full name
keycloak.keycloak_post_admin_realms_realm_workflows_migrate
ParameterTypeRequiredDescription
No parameters.
update_top_level_information_realm_any_user_roles_or_client_information_representation_will_be_ignored Write

This will only update top-level attributes of the realm.

Lua path
app.integrations.keycloak.update_top_level_information_realm_any_user_roles_or_client_information_representation_will_be_ignored
Full name
keycloak.keycloak_put_admin_realms_realm
ParameterTypeRequiredDescription
No parameters.
update_authenticator_configuration Write

Update authenticator configuration.

Lua path
app.integrations.keycloak.update_authenticator_configuration
Full name
keycloak.keycloak_put_admin_realms_realm_authentication_config_id
ParameterTypeRequiredDescription
No parameters.
update_authentication_executions_flow Write

Update authentication executions of a Flow.

Lua path
app.integrations.keycloak.update_authentication_executions_flow
Full name
keycloak.keycloak_put_admin_realms_realm_authentication_flows_flow_alias_executions
ParameterTypeRequiredDescription
No parameters.
update_authentication_flow Write

Update an authentication flow.

Lua path
app.integrations.keycloak.update_authentication_flow
Full name
keycloak.keycloak_put_admin_realms_realm_authentication_flows_id
ParameterTypeRequiredDescription
No parameters.
update_required_action Write

Update required action.

Lua path
app.integrations.keycloak.update_required_action
Full name
keycloak.keycloak_put_admin_realms_realm_authentication_required_actions_alias
ParameterTypeRequiredDescription
No parameters.
update_requiredaction_configuration Write

Update RequiredAction configuration.

Lua path
app.integrations.keycloak.update_requiredaction_configuration
Full name
keycloak.keycloak_put_admin_realms_realm_authentication_required_actions_alias_config
ParameterTypeRequiredDescription
No parameters.
put_admin_realms_realm_client_policies_policies Write

PUT /admin/realms/{realm}/client-policies/policies.

Lua path
app.integrations.keycloak.put_admin_realms_realm_client_policies_policies
Full name
keycloak.keycloak_put_admin_realms_realm_client_policies_policies
ParameterTypeRequiredDescription
No parameters.
put_admin_realms_realm_client_policies_profiles Write

PUT /admin/realms/{realm}/client-policies/profiles.

Lua path
app.integrations.keycloak.put_admin_realms_realm_client_policies_profiles
Full name
keycloak.keycloak_put_admin_realms_realm_client_policies_profiles
ParameterTypeRequiredDescription
No parameters.
update_client_scope Write

Update the client scope.

Lua path
app.integrations.keycloak.update_client_scope
Full name
keycloak.keycloak_put_admin_realms_realm_client_scopes_client_scope_id
ParameterTypeRequiredDescription
No parameters.
update_mapper Write

Update the mapper.

Lua path
app.integrations.keycloak.update_mapper
Full name
keycloak.keycloak_put_admin_realms_realm_client_scopes_client_scope_id_protocol_mappers_models_id
ParameterTypeRequiredDescription
No parameters.
update_client_scope Write

Update the client scope.

Lua path
app.integrations.keycloak.update_client_scope
Full name
keycloak.keycloak_put_admin_realms_realm_client_templates_client_scope_id
ParameterTypeRequiredDescription
No parameters.
update_mapper Write

Update the mapper.

Lua path
app.integrations.keycloak.update_mapper
Full name
keycloak.keycloak_put_admin_realms_realm_client_templates_client_scope_id_protocol_mappers_models_id
ParameterTypeRequiredDescription
No parameters.
update_client_type Write

This endpoint allows you to update a realm level client type

Lua path
app.integrations.keycloak.update_client_type
Full name
keycloak.keycloak_put_admin_realms_realm_client_types
ParameterTypeRequiredDescription
No parameters.
update_client Write

Update the client.

Lua path
app.integrations.keycloak.update_client
Full name
keycloak.keycloak_put_admin_realms_realm_clients_client_uuid
ParameterTypeRequiredDescription
No parameters.
put_admin_realms_realm_clients_client_uuid_authz_resource_server Write

PUT /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server.

Lua path
app.integrations.keycloak.put_admin_realms_realm_clients_client_uuid_authz_resource_server
Full name
keycloak.keycloak_put_admin_realms_realm_clients_client_uuid_authz_resource_server
ParameterTypeRequiredDescription
No parameters.
put_admin_realms_realm_clients_client_uuid_authz_resource_server_resource_resource_id Write

PUT /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/resource/{resource-id}.

Lua path
app.integrations.keycloak.put_admin_realms_realm_clients_client_uuid_authz_resource_server_resource_resource_id
Full name
keycloak.keycloak_put_admin_realms_realm_clients_client_uuid_authz_resource_server_resource_resource_id
ParameterTypeRequiredDescription
No parameters.
put_admin_realms_realm_clients_client_uuid_authz_resource_server_scope_scope_id Write

PUT /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/scope/{scope-id}.

Lua path
app.integrations.keycloak.put_admin_realms_realm_clients_client_uuid_authz_resource_server_scope_scope_id
Full name
keycloak.keycloak_put_admin_realms_realm_clients_client_uuid_authz_resource_server_scope_scope_id
ParameterTypeRequiredDescription
No parameters.
put_admin_realms_realm_clients_client_uuid_default_client_scopes_clientscopeid Write

PUT /admin/realms/{realm}/clients/{client-uuid}/default-client-scopes/{clientScopeId}.

Lua path
app.integrations.keycloak.put_admin_realms_realm_clients_client_uuid_default_client_scopes_clientscopeid
Full name
keycloak.keycloak_put_admin_realms_realm_clients_client_uuid_default_client_scopes_client_scope_id
ParameterTypeRequiredDescription
No parameters.
return_object_stating_whether_client_authorization_permissions_have_been_initialized_or_not_and_reference Write

Return object stating whether client Authorization permissions have been initialized or not and a reference.

Lua path
app.integrations.keycloak.return_object_stating_whether_client_authorization_permissions_have_been_initialized_or_not_and_reference
Full name
keycloak.keycloak_put_admin_realms_realm_clients_client_uuid_management_permissions
ParameterTypeRequiredDescription
No parameters.
put_admin_realms_realm_clients_client_uuid_optional_client_scopes_clientscopeid Write

PUT /admin/realms/{realm}/clients/{client-uuid}/optional-client-scopes/{clientScopeId}.

Lua path
app.integrations.keycloak.put_admin_realms_realm_clients_client_uuid_optional_client_scopes_clientscopeid
Full name
keycloak.keycloak_put_admin_realms_realm_clients_client_uuid_optional_client_scopes_client_scope_id
ParameterTypeRequiredDescription
No parameters.
update_mapper Write

Update the mapper.

Lua path
app.integrations.keycloak.update_mapper
Full name
keycloak.keycloak_put_admin_realms_realm_clients_client_uuid_protocol_mappers_models_id
ParameterTypeRequiredDescription
No parameters.
update_role_by_name Write

Update a role by name.

Lua path
app.integrations.keycloak.update_role_by_name
Full name
keycloak.keycloak_put_admin_realms_realm_clients_client_uuid_roles_role_name
ParameterTypeRequiredDescription
No parameters.
return_object_stating_whether_role_authorization_permissions_have_been_initialized_or_not_and_reference Write

Return object stating whether role Authorization permissions have been initialized or not and a reference.

Lua path
app.integrations.keycloak.return_object_stating_whether_role_authorization_permissions_have_been_initialized_or_not_and_reference
Full name
keycloak.keycloak_put_admin_realms_realm_clients_client_uuid_roles_role_name_management_permissions
ParameterTypeRequiredDescription
No parameters.
put_admin_realms_realm_components_id Write

PUT /admin/realms/{realm}/components/{id}.

Lua path
app.integrations.keycloak.put_admin_realms_realm_components_id
Full name
keycloak.keycloak_put_admin_realms_realm_components_id
ParameterTypeRequiredDescription
No parameters.
put_admin_realms_realm_default_default_client_scopes_clientscopeid Write

PUT /admin/realms/{realm}/default-default-client-scopes/{clientScopeId}.

Lua path
app.integrations.keycloak.put_admin_realms_realm_default_default_client_scopes_clientscopeid
Full name
keycloak.keycloak_put_admin_realms_realm_default_default_client_scopes_client_scope_id
ParameterTypeRequiredDescription
No parameters.
put_admin_realms_realm_default_groups_groupid Write

PUT /admin/realms/{realm}/default-groups/{groupId}.

Lua path
app.integrations.keycloak.put_admin_realms_realm_default_groups_groupid
Full name
keycloak.keycloak_put_admin_realms_realm_default_groups_group_id
ParameterTypeRequiredDescription
No parameters.
put_admin_realms_realm_default_optional_client_scopes_clientscopeid Write

PUT /admin/realms/{realm}/default-optional-client-scopes/{clientScopeId}.

Lua path
app.integrations.keycloak.put_admin_realms_realm_default_optional_client_scopes_clientscopeid
Full name
keycloak.keycloak_put_admin_realms_realm_default_optional_client_scopes_client_scope_id
ParameterTypeRequiredDescription
No parameters.
put_admin_realms_realm_events_config Write

Update the events provider Change the events provider and/or its configuration

Lua path
app.integrations.keycloak.put_admin_realms_realm_events_config
Full name
keycloak.keycloak_put_admin_realms_realm_events_config
ParameterTypeRequiredDescription
No parameters.
update_group_ignores_subgroups Write

Update group, ignores subgroups.

Lua path
app.integrations.keycloak.update_group_ignores_subgroups
Full name
keycloak.keycloak_put_admin_realms_realm_groups_group_id
ParameterTypeRequiredDescription
No parameters.
return_object_stating_whether_client_authorization_permissions_have_been_initialized_or_not_and_reference Write

Return object stating whether client Authorization permissions have been initialized or not and a reference.

Lua path
app.integrations.keycloak.return_object_stating_whether_client_authorization_permissions_have_been_initialized_or_not_and_reference
Full name
keycloak.keycloak_put_admin_realms_realm_groups_group_id_management_permissions
ParameterTypeRequiredDescription
No parameters.
update_identity_provider Write

Update the identity provider.

Lua path
app.integrations.keycloak.update_identity_provider
Full name
keycloak.keycloak_put_admin_realms_realm_identity_provider_instances_alias
ParameterTypeRequiredDescription
No parameters.
return_object_stating_whether_client_authorization_permissions_have_been_initialized_or_not_and_reference Write

Return object stating whether client Authorization permissions have been initialized or not and a reference.

Lua path
app.integrations.keycloak.return_object_stating_whether_client_authorization_permissions_have_been_initialized_or_not_and_reference
Full name
keycloak.keycloak_put_admin_realms_realm_identity_provider_instances_alias_management_permissions
ParameterTypeRequiredDescription
No parameters.
update_mapper_identity_provider Write

Update a mapper for the identity provider.

Lua path
app.integrations.keycloak.update_mapper_identity_provider
Full name
keycloak.keycloak_put_admin_realms_realm_identity_provider_instances_alias_mappers_id
ParameterTypeRequiredDescription
No parameters.
put_admin_realms_realm_localization_locale Write

PUT /admin/realms/{realm}/localization/{locale}/{key}.

Lua path
app.integrations.keycloak.put_admin_realms_realm_localization_locale
Full name
keycloak.keycloak_put_admin_realms_realm_localization_locale_key
ParameterTypeRequiredDescription
No parameters.
updates_organization Write

Updates the organization.

Lua path
app.integrations.keycloak.updates_organization
Full name
keycloak.keycloak_put_admin_realms_realm_organizations_org_id
ParameterTypeRequiredDescription
No parameters.
update_organization_group Write

Updates the organization group's name, description, and attributes. Subgroups are not affected.

Lua path
app.integrations.keycloak.update_organization_group
Full name
keycloak.keycloak_put_admin_realms_realm_organizations_org_id_groups_group_id
ParameterTypeRequiredDescription
No parameters.
add_user_this_organization_group Write

Adds an organization member to this group. The user must be a member of the organization.

Lua path
app.integrations.keycloak.add_user_this_organization_group
Full name
keycloak.keycloak_put_admin_realms_realm_organizations_org_id_groups_group_id_members_user_id
ParameterTypeRequiredDescription
No parameters.
update_role Write

Update the role.

Lua path
app.integrations.keycloak.update_role
Full name
keycloak.keycloak_put_admin_realms_realm_roles_by_id_role_id
ParameterTypeRequiredDescription
No parameters.
return_object_stating_whether_role_authorization_permissions_have_been_initialized_or_not_and_reference Write

Return object stating whether role Authorization permissions have been initialized or not and a reference.

Lua path
app.integrations.keycloak.return_object_stating_whether_role_authorization_permissions_have_been_initialized_or_not_and_reference
Full name
keycloak.keycloak_put_admin_realms_realm_roles_by_id_role_id_management_permissions
ParameterTypeRequiredDescription
No parameters.
update_role_by_name Write

Update a role by name.

Lua path
app.integrations.keycloak.update_role_by_name
Full name
keycloak.keycloak_put_admin_realms_realm_roles_role_name
ParameterTypeRequiredDescription
No parameters.
return_object_stating_whether_role_authorization_permissions_have_been_initialized_or_not_and_reference Write

Return object stating whether role Authorization permissions have been initialized or not and a reference.

Lua path
app.integrations.keycloak.return_object_stating_whether_role_authorization_permissions_have_been_initialized_or_not_and_reference
Full name
keycloak.keycloak_put_admin_realms_realm_roles_role_name_management_permissions
ParameterTypeRequiredDescription
No parameters.
put_admin_realms_realm_users_management_permissions Write

PUT /admin/realms/{realm}/users-management-permissions.

Lua path
app.integrations.keycloak.put_admin_realms_realm_users_management_permissions
Full name
keycloak.keycloak_put_admin_realms_realm_users_management_permissions
ParameterTypeRequiredDescription
No parameters.
put_admin_realms_realm_users_profile Write

Set the configuration for the user profile

Lua path
app.integrations.keycloak.put_admin_realms_realm_users_profile
Full name
keycloak.keycloak_put_admin_realms_realm_users_profile
ParameterTypeRequiredDescription
No parameters.
update_user Write

Update the user.

Lua path
app.integrations.keycloak.update_user
Full name
keycloak.keycloak_put_admin_realms_realm_users_user_id
ParameterTypeRequiredDescription
No parameters.
update_credential_label_user Write

Update a credential label for a user.

Lua path
app.integrations.keycloak.update_credential_label_user
Full name
keycloak.keycloak_put_admin_realms_realm_users_user_id_credentials_credential_id_user_label
ParameterTypeRequiredDescription
No parameters.
disable_all_credentials_user_specific_type Write

Disable all credentials for a user of a specific type.

Lua path
app.integrations.keycloak.disable_all_credentials_user_specific_type
Full name
keycloak.keycloak_put_admin_realms_realm_users_user_id_disable_credential_types
ParameterTypeRequiredDescription
No parameters.
put_admin_realms_realm_users_user_id_groups_groupid Write

PUT /admin/realms/{realm}/users/{user-id}/groups/{groupId}.

Lua path
app.integrations.keycloak.put_admin_realms_realm_users_user_id_groups_groupid
Full name
keycloak.keycloak_put_admin_realms_realm_users_user_id_groups_group_id
ParameterTypeRequiredDescription
No parameters.
set_up_new_password_user Write

Set up a new password for the user.

Lua path
app.integrations.keycloak.set_up_new_password_user
Full name
keycloak.keycloak_put_admin_realms_realm_users_user_id_reset_password
ParameterTypeRequiredDescription
No parameters.
update_workflow Write

Update the workflow configuration. This method does not update the workflow steps.

Lua path
app.integrations.keycloak.update_workflow
Full name
keycloak.keycloak_put_admin_realms_realm_workflows_id
ParameterTypeRequiredDescription
No parameters.