Struct keycloak::KeycloakAdmin[][src]

pub struct KeycloakAdmin<'a> { /* fields omitted */ }

Implementations

impl<'a> KeycloakAdmin<'a>[src]

pub async fn realm_attack_detection_brute_force_users_delete(
    &self,
    realm: &str
) -> Result<(), KeycloakError>
[src]

Clear any user login failures for all users This can release temporary disabled users DELETE /{realm}/attack-detection/brute-force/users

pub async fn realm_attack_detection_brute_force_users_with_user_id_get(
    &self,
    realm: &str,
    user_id: &str
) -> Result<HashMap<Cow<'static, str>, Value>, KeycloakError>
[src]

Get status of a username in brute force detection GET /{realm}/attack-detection/brute-force/users/{userId}

pub async fn realm_attack_detection_brute_force_users_with_user_id_delete(
    &self,
    realm: &str,
    user_id: &str
) -> Result<(), KeycloakError>
[src]

Clear any user login failures for the user This can release temporary disabled user DELETE /{realm}/attack-detection/brute-force/users/{userId}

pub async fn realm_authentication_authenticator_providers_get(
    &self,
    realm: &str
) -> Result<Vec<HashMap<Cow<'static, str>, Value>>, KeycloakError>
[src]

Get authenticator providers Returns a list of authenticator providers. GET /{realm}/authentication/authenticator-providers

pub async fn realm_authentication_client_authenticator_providers_get(
    &self,
    realm: &str
) -> Result<Vec<HashMap<Cow<'static, str>, Value>>, KeycloakError>
[src]

Get client authenticator providers Returns a list of client authenticator providers. GET /{realm}/authentication/client-authenticator-providers

pub async fn realm_authentication_config_description_with_provider_id_get(
    &self,
    realm: &str,
    provider_id: &str
) -> Result<AuthenticatorConfigInfoRepresentation<'static>, KeycloakError>
[src]

Get authenticator provider’s configuration description GET /{realm}/authentication/config-description/{providerId}

pub async fn realm_authentication_config_with_id_get(
    &self,
    realm: &str,
    id: &str
) -> Result<AuthenticatorConfigRepresentation<'static>, KeycloakError>
[src]

Get authenticator configuration GET /{realm}/authentication/config/{id}

pub async fn realm_authentication_config_with_id_put(
    &self,
    realm: &str,
    id: &str,
    rep: AuthenticatorConfigRepresentation<'_>
) -> Result<(), KeycloakError>
[src]

Update authenticator configuration PUT /{realm}/authentication/config/{id}

pub async fn realm_authentication_config_with_id_delete(
    &self,
    realm: &str,
    id: &str
) -> Result<(), KeycloakError>
[src]

Delete authenticator configuration DELETE /{realm}/authentication/config/{id}

pub async fn realm_authentication_executions_post(
    &self,
    realm: &str,
    execution: AuthenticationExecutionRepresentation<'_>
) -> Result<(), KeycloakError>
[src]

Add new authentication execution POST /{realm}/authentication/executions

pub async fn realm_authentication_executions_with_execution_id_get(
    &self,
    realm: &str,
    execution_id: &str
) -> Result<(), KeycloakError>
[src]

Get Single Execution GET /{realm}/authentication/executions/{executionId}

pub async fn realm_authentication_executions_with_execution_id_delete(
    &self,
    realm: &str,
    execution_id: &str
) -> Result<(), KeycloakError>
[src]

Delete execution DELETE /{realm}/authentication/executions/{executionId}

pub async fn realm_authentication_executions_with_execution_id_config_post(
    &self,
    realm: &str,
    execution_id: &str,
    json: AuthenticatorConfigRepresentation<'_>
) -> Result<(), KeycloakError>
[src]

Update execution with new configuration POST /{realm}/authentication/executions/{executionId}/config

pub async fn realm_authentication_executions_with_execution_id_lower_priority_post(
    &self,
    realm: &str,
    execution_id: &str
) -> Result<(), KeycloakError>
[src]

Lower execution’s priority POST /{realm}/authentication/executions/{executionId}/lower-priority

pub async fn realm_authentication_executions_with_execution_id_raise_priority_post(
    &self,
    realm: &str,
    execution_id: &str
) -> Result<(), KeycloakError>
[src]

Raise execution’s priority POST /{realm}/authentication/executions/{executionId}/raise-priority

pub async fn realm_authentication_flows_post(
    &self,
    realm: &str,
    flow: AuthenticationFlowRepresentation<'_>
) -> Result<(), KeycloakError>
[src]

Create a new authentication flow POST /{realm}/authentication/flows

pub async fn realm_authentication_flows_get(
    &self,
    realm: &str
) -> Result<Vec<AuthenticationFlowRepresentation<'static>>, KeycloakError>
[src]

Get authentication flows Returns a list of authentication flows. GET /{realm}/authentication/flows

pub async fn realm_authentication_flows_with_flow_alias_copy_post(
    &self,
    realm: &str,
    flow_alias: &str,
    data: HashMap<&str, Value>
) -> Result<(), KeycloakError>
[src]

Copy existing authentication flow under a new name The new name is given as 'newName' attribute of the passed JSON object POST /{realm}/authentication/flows/{flowAlias}/copy

pub async fn realm_authentication_flows_with_flow_alias_executions_get(
    &self,
    realm: &str,
    flow_alias: &str
) -> Result<(), KeycloakError>
[src]

Get authentication executions for a flow GET /{realm}/authentication/flows/{flowAlias}/executions

pub async fn realm_authentication_flows_with_flow_alias_executions_put(
    &self,
    realm: &str,
    flow_alias: &str,
    rep: AuthenticationExecutionInfoRepresentation<'_>
) -> Result<(), KeycloakError>
[src]

Update authentication executions of a Flow PUT /{realm}/authentication/flows/{flowAlias}/executions

pub async fn realm_authentication_flows_with_flow_alias_executions_execution_post(
    &self,
    realm: &str,
    flow_alias: &str,
    data: HashMap<&str, Value>
) -> Result<(), KeycloakError>
[src]

Add new authentication execution to a flow POST /{realm}/authentication/flows/{flowAlias}/executions/execution

pub async fn realm_authentication_flows_with_flow_alias_executions_flow_post(
    &self,
    realm: &str,
    flow_alias: &str,
    data: HashMap<&str, Value>
) -> Result<(), KeycloakError>
[src]

Add new flow with new execution to existing flow POST /{realm}/authentication/flows/{flowAlias}/executions/flow

pub async fn realm_authentication_flows_with_id_get(
    &self,
    realm: &str,
    id: &str
) -> Result<AuthenticationFlowRepresentation<'static>, KeycloakError>
[src]

Get authentication flow for id GET /{realm}/authentication/flows/{id}

pub async fn realm_authentication_flows_with_id_put(
    &self,
    realm: &str,
    id: &str,
    flow: AuthenticationFlowRepresentation<'_>
) -> Result<(), KeycloakError>
[src]

Update an authentication flow PUT /{realm}/authentication/flows/{id}

pub async fn realm_authentication_flows_with_id_delete(
    &self,
    realm: &str,
    id: &str
) -> Result<(), KeycloakError>
[src]

Delete an authentication flow DELETE /{realm}/authentication/flows/{id}

pub async fn realm_authentication_form_action_providers_get(
    &self,
    realm: &str
) -> Result<Vec<HashMap<Cow<'static, str>, Value>>, KeycloakError>
[src]

Get form action providers Returns a list of form action providers. GET /{realm}/authentication/form-action-providers

pub async fn realm_authentication_form_providers_get(
    &self,
    realm: &str
) -> Result<Vec<HashMap<Cow<'static, str>, Value>>, KeycloakError>
[src]

Get form providers Returns a list of form providers. GET /{realm}/authentication/form-providers

pub async fn realm_authentication_per_client_config_description_get(
    &self,
    realm: &str
) -> Result<HashMap<Cow<'static, str>, Value>, KeycloakError>
[src]

Get configuration descriptions for all clients GET /{realm}/authentication/per-client-config-description

pub async fn realm_authentication_register_required_action_post(
    &self,
    realm: &str,
    data: HashMap<&str, Value>
) -> Result<(), KeycloakError>
[src]

Register a new required actions POST /{realm}/authentication/register-required-action

pub async fn realm_authentication_required_actions_get(
    &self,
    realm: &str
) -> Result<Vec<RequiredActionProviderRepresentation<'static>>, KeycloakError>
[src]

Get required actions Returns a list of required actions. GET /{realm}/authentication/required-actions

pub async fn realm_authentication_required_actions_with_alias_get(
    &self,
    realm: &str,
    alias: &str
) -> Result<RequiredActionProviderRepresentation<'static>, KeycloakError>
[src]

Get required action for alias GET /{realm}/authentication/required-actions/{alias}

pub async fn realm_authentication_required_actions_with_alias_put(
    &self,
    realm: &str,
    alias: &str,
    rep: RequiredActionProviderRepresentation<'_>
) -> Result<(), KeycloakError>
[src]

Update required action PUT /{realm}/authentication/required-actions/{alias}

pub async fn realm_authentication_required_actions_with_alias_delete(
    &self,
    realm: &str,
    alias: &str
) -> Result<(), KeycloakError>
[src]

Delete required action DELETE /{realm}/authentication/required-actions/{alias}

pub async fn realm_authentication_required_actions_with_alias_lower_priority_post(
    &self,
    realm: &str,
    alias: &str
) -> Result<(), KeycloakError>
[src]

Lower required action’s priority POST /{realm}/authentication/required-actions/{alias}/lower-priority

pub async fn realm_authentication_required_actions_with_alias_raise_priority_post(
    &self,
    realm: &str,
    alias: &str
) -> Result<(), KeycloakError>
[src]

Raise required action’s priority POST /{realm}/authentication/required-actions/{alias}/raise-priority

pub async fn realm_authentication_unregistered_required_actions_get(
    &self,
    realm: &str
) -> Result<Vec<HashMap<Cow<'static, str>, Value>>, KeycloakError>
[src]

Get unregistered required actions Returns a list of unregistered required actions. GET /{realm}/authentication/unregistered-required-actions

pub async fn realm_clients_with_id_certificates_with_attr_get(
    &self,
    realm: &str,
    id: &str,
    attr: &str
) -> Result<CertificateRepresentation<'static>, KeycloakError>
[src]

Get key info GET /{realm}/clients/{id}/certificates/{attr}

pub async fn realm_clients_with_id_certificates_with_attr_download_post(
    &self,
    realm: &str,
    id: &str,
    attr: &str,
    config: KeyStoreConfig<'_>
) -> Result<Vec<u8>, KeycloakError>
[src]

Get a keystore file for the client, containing private key and public certificate POST /{realm}/clients/{id}/certificates/{attr}/download

pub async fn realm_clients_with_id_certificates_with_attr_generate_post(
    &self,
    realm: &str,
    id: &str,
    attr: &str
) -> Result<CertificateRepresentation<'static>, KeycloakError>
[src]

Generate a new certificate with new key pair POST /{realm}/clients/{id}/certificates/{attr}/generate

pub async fn realm_clients_with_id_certificates_with_attr_generate_and_download_post(
    &self,
    realm: &str,
    id: &str,
    attr: &str,
    config: KeyStoreConfig<'_>
) -> Result<Vec<u8>, KeycloakError>
[src]

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. POST /{realm}/clients/{id}/certificates/{attr}/generate-and-download

pub async fn realm_clients_with_id_certificates_with_attr_upload_post(
    &self,
    realm: &str,
    id: &str,
    attr: &str,
    input: &[u8]
) -> Result<CertificateRepresentation<'static>, KeycloakError>
[src]

Upload certificate and eventually private key POST /{realm}/clients/{id}/certificates/{attr}/upload

pub async fn realm_clients_with_id_certificates_with_attr_upload_certificate_post(
    &self,
    realm: &str,
    id: &str,
    attr: &str,
    input: &[u8]
) -> Result<CertificateRepresentation<'static>, KeycloakError>
[src]

Upload only certificate, not private key POST /{realm}/clients/{id}/certificates/{attr}/upload-certificate

pub async fn realm_clients_initial_access_post(
    &self,
    realm: &str,
    config: ClientInitialAccessCreatePresentation
) -> Result<ClientInitialAccessPresentation<'static>, KeycloakError>
[src]

Create a new initial access token. POST /{realm}/clients-initial-access

pub async fn realm_clients_initial_access_get(
    &self,
    realm: &str
) -> Result<Vec<ClientInitialAccessPresentation<'static>>, KeycloakError>
[src]

GET /{realm}/clients-initial-access

pub async fn realm_clients_initial_access_with_id_delete(
    &self,
    realm: &str,
    id: &str
) -> Result<(), KeycloakError>
[src]

DELETE /{realm}/clients-initial-access/{id}

pub async fn realm_client_registration_policy_providers_get(
    &self,
    realm: &str
) -> Result<Vec<ComponentTypeRepresentation<'static>>, KeycloakError>
[src]

Base path for retrieve providers with the configProperties properly filled GET /{realm}/client-registration-policy/providers

pub async fn realm_groups_with_id_role_mappings_clients_with_client_post(
    &self,
    realm: &str,
    id: &str,
    client: &str,
    roles: Vec<RoleRepresentation<'_>>
) -> Result<(), KeycloakError>
[src]

Add client-level roles to the user role mapping POST /{realm}/groups/{id}/role-mappings/clients/{client}

pub async fn realm_groups_with_id_role_mappings_clients_with_client_get(
    &self,
    realm: &str,
    id: &str,
    client: &str
) -> Result<Vec<RoleRepresentation<'static>>, KeycloakError>
[src]

Get client-level role mappings for the user, and the app GET /{realm}/groups/{id}/role-mappings/clients/{client}

pub async fn realm_groups_with_id_role_mappings_clients_with_client_delete(
    &self,
    realm: &str,
    id: &str,
    client: &str,
    roles: Vec<RoleRepresentation<'_>>
) -> Result<(), KeycloakError>
[src]

Delete client-level roles from user role mapping DELETE /{realm}/groups/{id}/role-mappings/clients/{client}

pub async fn realm_groups_with_id_role_mappings_clients_with_client_available_get(
    &self,
    realm: &str,
    id: &str,
    client: &str
) -> Result<Vec<RoleRepresentation<'static>>, KeycloakError>
[src]

Get available client-level roles that can be mapped to the user GET /{realm}/groups/{id}/role-mappings/clients/{client}/available

pub async fn realm_groups_with_id_role_mappings_clients_with_client_composite_get(
    &self,
    realm: &str,
    id: &str,
    client: &str,
    brief_representation: Option<bool>
) -> Result<Vec<RoleRepresentation<'static>>, KeycloakError>
[src]

Get effective client-level role mappings This recurses any composite roles GET /{realm}/groups/{id}/role-mappings/clients/{client}/composite

pub async fn realm_users_with_id_role_mappings_clients_with_client_post(
    &self,
    realm: &str,
    id: &str,
    client: &str,
    roles: Vec<RoleRepresentation<'_>>
) -> Result<(), KeycloakError>
[src]

Add client-level roles to the user role mapping POST /{realm}/users/{id}/role-mappings/clients/{client}

pub async fn realm_users_with_id_role_mappings_clients_with_client_get(
    &self,
    realm: &str,
    id: &str,
    client: &str
) -> Result<Vec<RoleRepresentation<'static>>, KeycloakError>
[src]

Get client-level role mappings for the user, and the app GET /{realm}/users/{id}/role-mappings/clients/{client}

pub async fn realm_users_with_id_role_mappings_clients_with_client_delete(
    &self,
    realm: &str,
    id: &str,
    client: &str,
    roles: Vec<RoleRepresentation<'_>>
) -> Result<(), KeycloakError>
[src]

Delete client-level roles from user role mapping DELETE /{realm}/users/{id}/role-mappings/clients/{client}

pub async fn realm_users_with_id_role_mappings_clients_with_client_available_get(
    &self,
    realm: &str,
    id: &str,
    client: &str
) -> Result<Vec<RoleRepresentation<'static>>, KeycloakError>
[src]

Get available client-level roles that can be mapped to the user GET /{realm}/users/{id}/role-mappings/clients/{client}/available

pub async fn realm_users_with_id_role_mappings_clients_with_client_composite_get(
    &self,
    realm: &str,
    id: &str,
    client: &str,
    brief_representation: Option<bool>
) -> Result<Vec<RoleRepresentation<'static>>, KeycloakError>
[src]

Get effective client-level role mappings This recurses any composite roles GET /{realm}/users/{id}/role-mappings/clients/{client}/composite

pub async fn realm_client_scopes_post(
    &self,
    realm: &str,
    rep: ClientScopeRepresentation<'_>
) -> Result<(), KeycloakError>
[src]

Create a new client scope Client Scope’s name must be unique! POST /{realm}/client-scopes

pub async fn realm_client_scopes_get(
    &self,
    realm: &str
) -> Result<Vec<ClientScopeRepresentation<'static>>, KeycloakError>
[src]

Get client scopes belonging to the realm Returns a list of client scopes belonging to the realm GET /{realm}/client-scopes

pub async fn realm_client_scopes_with_id_get(
    &self,
    realm: &str,
    id: &str
) -> Result<ClientScopeRepresentation<'static>, KeycloakError>
[src]

Get representation of the client scope GET /{realm}/client-scopes/{id}

pub async fn realm_client_scopes_with_id_put(
    &self,
    realm: &str,
    id: &str,
    rep: ClientScopeRepresentation<'_>
) -> Result<(), KeycloakError>
[src]

Update the client scope PUT /{realm}/client-scopes/{id}

pub async fn realm_client_scopes_with_id_delete(
    &self,
    realm: &str,
    id: &str
) -> Result<(), KeycloakError>
[src]

Delete the client scope DELETE /{realm}/client-scopes/{id}

pub async fn realm_clients_post(
    &self,
    realm: &str,
    rep: ClientRepresentation<'_>
) -> Result<(), KeycloakError>
[src]

Create a new client Client’s client_id must be unique! POST /{realm}/clients

pub async fn realm_clients_get(
    &self,
    realm: &str,
    client_id: Option<&str>,
    first: Option<i32>,
    max: Option<i32>,
    search: Option<bool>,
    viewable_only: Option<bool>
) -> Result<Vec<ClientRepresentation<'static>>, KeycloakError>
[src]

Get clients belonging to the realm Returns a list of clients belonging to the realm GET /{realm}/clients

pub async fn realm_clients_with_id_get(
    &self,
    realm: &str,
    id: &str
) -> Result<ClientRepresentation<'static>, KeycloakError>
[src]

Get representation of the client GET /{realm}/clients/{id}

pub async fn realm_clients_with_id_put(
    &self,
    realm: &str,
    id: &str,
    rep: ClientRepresentation<'_>
) -> Result<(), KeycloakError>
[src]

Update the client PUT /{realm}/clients/{id}

pub async fn realm_clients_with_id_delete(
    &self,
    realm: &str,
    id: &str
) -> Result<(), KeycloakError>
[src]

Delete the client DELETE /{realm}/clients/{id}

pub async fn realm_clients_with_id_client_secret_post(
    &self,
    realm: &str,
    id: &str
) -> Result<CredentialRepresentation<'static>, KeycloakError>
[src]

Generate a new secret for the client POST /{realm}/clients/{id}/client-secret

pub async fn realm_clients_with_id_client_secret_get(
    &self,
    realm: &str,
    id: &str
) -> Result<CredentialRepresentation<'static>, KeycloakError>
[src]

Get the client secret GET /{realm}/clients/{id}/client-secret

pub async fn realm_clients_with_id_default_client_scopes_get(
    &self,
    realm: &str,
    id: &str
) -> Result<Vec<ClientScopeRepresentation<'static>>, KeycloakError>
[src]

Get default client scopes. Only name and ids are returned. GET /{realm}/clients/{id}/default-client-scopes

pub async fn realm_clients_with_id_default_client_scopes_with_client_scope_id_put(
    &self,
    realm: &str,
    id: &str,
    client_scope_id: &str
) -> Result<(), KeycloakError>
[src]

PUT /{realm}/clients/{id}/default-client-scopes/{clientScopeId}

pub async fn realm_clients_with_id_default_client_scopes_with_client_scope_id_delete(
    &self,
    realm: &str,
    id: &str,
    client_scope_id: &str
) -> Result<(), KeycloakError>
[src]

DELETE /{realm}/clients/{id}/default-client-scopes/{clientScopeId}

pub async fn realm_clients_with_id_evaluate_scopes_generate_example_access_token_get(
    &self,
    realm: &str,
    id: &str,
    scope: Option<&str>,
    user_id: Option<&str>
) -> Result<AccessToken<'static>, KeycloakError>
[src]

Create JSON with payload of example access token GET /{realm}/clients/{id}/evaluate-scopes/generate-example-access-token

pub async fn realm_clients_with_id_evaluate_scopes_protocol_mappers_get(
    &self,
    realm: &str,
    id: &str,
    scope: Option<&str>
) -> Result<Vec<ClientScopeEvaluateResourceProtocolMapperEvaluationRepresentation<'static>>, KeycloakError>
[src]

Return list of all protocol mappers, which will be used when generating tokens issued for particular client. This means protocol mappers assigned to this client directly and protocol mappers assigned to all client scopes of this client. GET /{realm}/clients/{id}/evaluate-scopes/protocol-mappers

pub async fn realm_clients_with_id_evaluate_scopes_scope_mappings_with_role_container_id_granted_get(
    &self,
    realm: &str,
    id: &str,
    role_container_id: &str,
    scope: Option<&str>
) -> Result<Vec<RoleRepresentation<'static>>, KeycloakError>
[src]

Get effective scope mapping of all roles of particular role container, which this client is defacto allowed to have in the accessToken issued for him. 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. GET /{realm}/clients/{id}/evaluate-scopes/scope-mappings/{roleContainerId}/granted

pub async fn realm_clients_with_id_evaluate_scopes_scope_mappings_with_role_container_id_not_granted_get(
    &self,
    realm: &str,
    id: &str,
    role_container_id: &str,
    scope: Option<&str>
) -> Result<Vec<RoleRepresentation<'static>>, KeycloakError>
[src]

Get roles, which this client doesn’t have scope for and can’t have them in the accessToken issued for him. Defacto all the other roles of particular role container, which are not in {@link #getGrantedScopeMappings()} GET /{realm}/clients/{id}/evaluate-scopes/scope-mappings/{roleContainerId}/not-granted

pub async fn realm_clients_with_id_installation_providers_with_provider_id_get(
    &self,
    realm: &str,
    id: &str,
    provider_id: &str
) -> Result<(), KeycloakError>
[src]

GET /{realm}/clients/{id}/installation/providers/{providerId}

pub async fn realm_clients_with_id_management_permissions_get(
    &self,
    realm: &str,
    id: &str
) -> Result<ManagementPermissionReference<'static>, KeycloakError>
[src]

Return object stating whether client Authorization permissions have been initialized or not and a reference GET /{realm}/clients/{id}/management/permissions

pub async fn realm_clients_with_id_management_permissions_put(
    &self,
    realm: &str,
    id: &str,
    ref_: ManagementPermissionReference<'_>
) -> Result<ManagementPermissionReference<'static>, KeycloakError>
[src]

Return object stating whether client Authorization permissions have been initialized or not and a reference PUT /{realm}/clients/{id}/management/permissions

pub async fn realm_clients_with_id_nodes_post(
    &self,
    realm: &str,
    id: &str,
    form_params: HashMap<&str, Value>
) -> Result<(), KeycloakError>
[src]

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 POST /{realm}/clients/{id}/nodes

pub async fn realm_clients_with_id_nodes_with_node_delete(
    &self,
    realm: &str,
    id: &str,
    node: &str
) -> Result<(), KeycloakError>
[src]

Unregister a cluster node from the client DELETE /{realm}/clients/{id}/nodes/{node}

pub async fn realm_clients_with_id_offline_session_count_get(
    &self,
    realm: &str,
    id: &str
) -> Result<HashMap<Cow<'static, str>, Value>, KeycloakError>
[src]

Get application offline session count Returns a number of offline user sessions associated with this client { "count": number } GET /{realm}/clients/{id}/offline-session-count

pub async fn realm_clients_with_id_offline_sessions_get(
    &self,
    realm: &str,
    id: &str,
    first: Option<i32>,
    max: Option<i32>
) -> Result<Vec<HashMap<Cow<'static, str>, Value>>, KeycloakError>
[src]

Get offline sessions for client Returns a list of offline user sessions associated with this client GET /{realm}/clients/{id}/offline-sessions

pub async fn realm_clients_with_id_optional_client_scopes_get(
    &self,
    realm: &str,
    id: &str
) -> Result<Vec<ClientScopeRepresentation<'static>>, KeycloakError>
[src]

Get optional client scopes. Only name and ids are returned. GET /{realm}/clients/{id}/optional-client-scopes

pub async fn realm_clients_with_id_optional_client_scopes_with_client_scope_id_put(
    &self,
    realm: &str,
    id: &str,
    client_scope_id: &str
) -> Result<(), KeycloakError>
[src]

PUT /{realm}/clients/{id}/optional-client-scopes/{clientScopeId}

pub async fn realm_clients_with_id_optional_client_scopes_with_client_scope_id_delete(
    &self,
    realm: &str,
    id: &str,
    client_scope_id: &str
) -> Result<(), KeycloakError>
[src]

DELETE /{realm}/clients/{id}/optional-client-scopes/{clientScopeId}

pub async fn realm_clients_with_id_push_revocation_post(
    &self,
    realm: &str,
    id: &str
) -> Result<GlobalRequestResult<'static>, KeycloakError>
[src]

Push the client’s revocation policy to its admin URL If the client has an admin URL, push revocation policy to it. POST /{realm}/clients/{id}/push-revocation

pub async fn realm_clients_with_id_registration_access_token_post(
    &self,
    realm: &str,
    id: &str
) -> Result<ClientRepresentation<'static>, KeycloakError>
[src]

Generate a new registration access token for the client POST /{realm}/clients/{id}/registration-access-token

pub async fn realm_clients_with_id_service_account_user_get(
    &self,
    realm: &str,
    id: &str
) -> Result<UserRepresentation<'static>, KeycloakError>
[src]

Get a user dedicated to the service account GET /{realm}/clients/{id}/service-account-user

pub async fn realm_clients_with_id_session_count_get(
    &self,
    realm: &str,
    id: &str
) -> Result<HashMap<Cow<'static, str>, Value>, KeycloakError>
[src]

Get application session count Returns a number of user sessions associated with this client { "count": number } GET /{realm}/clients/{id}/session-count

pub async fn realm_clients_with_id_test_nodes_available_get(
    &self,
    realm: &str,
    id: &str
) -> Result<GlobalRequestResult<'static>, KeycloakError>
[src]

Test if registered cluster nodes are available Tests availability by sending 'ping' request to all cluster nodes. GET /{realm}/clients/{id}/test-nodes-available

pub async fn realm_clients_with_id_user_sessions_get(
    &self,
    realm: &str,
    id: &str,
    first: Option<i32>,
    max: Option<i32>
) -> Result<Vec<HashMap<Cow<'static, str>, Value>>, KeycloakError>
[src]

Get user sessions for client Returns a list of user sessions associated with this client GET /{realm}/clients/{id}/user-sessions

pub async fn realm_components_post(
    &self,
    realm: &str,
    rep: ComponentRepresentation<'_>
) -> Result<(), KeycloakError>
[src]

POST /{realm}/components

pub async fn realm_components_get(
    &self,
    realm: &str,
    name: Option<&str>,
    parent: Option<&str>,
    type_: Option<&str>
) -> Result<Vec<ComponentRepresentation<'static>>, KeycloakError>
[src]

GET /{realm}/components

pub async fn realm_components_with_id_get(
    &self,
    realm: &str,
    id: &str
) -> Result<ComponentRepresentation<'static>, KeycloakError>
[src]

GET /{realm}/components/{id}

pub async fn realm_components_with_id_put(
    &self,
    realm: &str,
    id: &str,
    rep: ComponentRepresentation<'_>
) -> Result<(), KeycloakError>
[src]

PUT /{realm}/components/{id}

pub async fn realm_components_with_id_delete(
    &self,
    realm: &str,
    id: &str
) -> Result<(), KeycloakError>
[src]

DELETE /{realm}/components/{id}

pub async fn realm_components_with_id_sub_component_types_get(
    &self,
    realm: &str,
    id: &str,
    type_: Option<&str>
) -> Result<Vec<ComponentTypeRepresentation<'static>>, KeycloakError>
[src]

List of subcomponent types that are available to configure for a particular parent component. GET /{realm}/components/{id}/sub-component-types

pub async fn realm_groups_post(
    &self,
    realm: &str,
    rep: GroupRepresentation<'_>
) -> Result<(), KeycloakError>
[src]

create or add a top level realm groupSet or create child. This will update the group and set the parent if it exists. Create it and set the parent if the group doesn’t exist. POST /{realm}/groups

pub async fn realm_groups_get(
    &self,
    realm: &str,
    brief_representation: Option<bool>,
    first: Option<i32>,
    max: Option<i32>,
    search: Option<&str>
) -> Result<Vec<GroupRepresentation<'static>>, KeycloakError>
[src]

Get group hierarchy. Only name and ids are returned. GET /{realm}/groups

pub async fn realm_groups_count_get(
    &self,
    realm: &str,
    search: Option<&str>,
    top: Option<bool>
) -> Result<HashMap<Cow<'static, str>, Value>, KeycloakError>
[src]

Returns the groups counts. GET /{realm}/groups/count

pub async fn realm_groups_with_id_get(
    &self,
    realm: &str,
    id: &str
) -> Result<GroupRepresentation<'static>, KeycloakError>
[src]

GET /{realm}/groups/{id}

pub async fn realm_groups_with_id_put(
    &self,
    realm: &str,
    id: &str,
    rep: GroupRepresentation<'_>
) -> Result<(), KeycloakError>
[src]

Update group, ignores subgroups. PUT /{realm}/groups/{id}

pub async fn realm_groups_with_id_delete(
    &self,
    realm: &str,
    id: &str
) -> Result<(), KeycloakError>
[src]

DELETE /{realm}/groups/{id}

pub async fn realm_groups_with_id_children_post(
    &self,
    realm: &str,
    id: &str,
    rep: GroupRepresentation<'_>
) -> Result<(), KeycloakError>
[src]

Set or create child. This will just set the parent if it exists. Create it and set the parent if the group doesn’t exist. POST /{realm}/groups/{id}/children

pub async fn realm_groups_with_id_management_permissions_get(
    &self,
    realm: &str,
    id: &str
) -> Result<ManagementPermissionReference<'static>, KeycloakError>
[src]

Return object stating whether client Authorization permissions have been initialized or not and a reference GET /{realm}/groups/{id}/management/permissions

pub async fn realm_groups_with_id_management_permissions_put(
    &self,
    realm: &str,
    id: &str,
    ref_: ManagementPermissionReference<'_>
) -> Result<ManagementPermissionReference<'static>, KeycloakError>
[src]

Return object stating whether client Authorization permissions have been initialized or not and a reference PUT /{realm}/groups/{id}/management/permissions

pub async fn realm_groups_with_id_members_get(
    &self,
    realm: &str,
    id: &str,
    brief_representation: Option<bool>,
    first: Option<i32>,
    max: Option<i32>
) -> Result<Vec<UserRepresentation<'static>>, KeycloakError>
[src]

Get users Returns a stream of users, filtered according to query parameters GET /{realm}/groups/{id}/members

pub async fn realm_identity_provider_import_config_post(
    &self,
    realm: &str,
    input: &[u8]
) -> Result<HashMap<Cow<'static, str>, Value>, KeycloakError>
[src]

Import identity provider from uploaded JSON file POST /{realm}/identity-provider/import-config

pub async fn realm_identity_provider_instances_post(
    &self,
    realm: &str,
    representation: IdentityProviderRepresentation<'_>
) -> Result<(), KeycloakError>
[src]

Create a new identity provider POST /{realm}/identity-provider/instances

pub async fn realm_identity_provider_instances_get(
    &self,
    realm: &str
) -> Result<Vec<IdentityProviderRepresentation<'static>>, KeycloakError>
[src]

Get identity providers GET /{realm}/identity-provider/instances

pub async fn realm_identity_provider_instances_with_alias_get(
    &self,
    realm: &str,
    alias: &str
) -> Result<IdentityProviderRepresentation<'static>, KeycloakError>
[src]

Get the identity provider GET /{realm}/identity-provider/instances/{alias}

pub async fn realm_identity_provider_instances_with_alias_put(
    &self,
    realm: &str,
    alias: &str,
    provider_rep: IdentityProviderRepresentation<'_>
) -> Result<(), KeycloakError>
[src]

Update the identity provider PUT /{realm}/identity-provider/instances/{alias}

pub async fn realm_identity_provider_instances_with_alias_delete(
    &self,
    realm: &str,
    alias: &str
) -> Result<(), KeycloakError>
[src]

Delete the identity provider DELETE /{realm}/identity-provider/instances/{alias}

pub async fn realm_identity_provider_instances_with_alias_export_get(
    &self,
    realm: &str,
    alias: &str,
    format: Option<&str>
) -> Result<(), KeycloakError>
[src]

Export public broker configuration for identity provider GET /{realm}/identity-provider/instances/{alias}/export

pub async fn realm_identity_provider_instances_with_alias_management_permissions_get(
    &self,
    realm: &str,
    alias: &str
) -> Result<ManagementPermissionReference<'static>, KeycloakError>
[src]

Return object stating whether client Authorization permissions have been initialized or not and a reference GET /{realm}/identity-provider/instances/{alias}/management/permissions

pub async fn realm_identity_provider_instances_with_alias_management_permissions_put(
    &self,
    realm: &str,
    alias: &str,
    ref_: ManagementPermissionReference<'_>
) -> Result<ManagementPermissionReference<'static>, KeycloakError>
[src]

Return object stating whether client Authorization permissions have been initialized or not and a reference PUT /{realm}/identity-provider/instances/{alias}/management/permissions

pub async fn realm_identity_provider_instances_with_alias_mapper_types_get(
    &self,
    realm: &str,
    alias: &str
) -> Result<HashMap<Cow<'static, str>, Value>, KeycloakError>
[src]

Get mapper types for identity provider GET /{realm}/identity-provider/instances/{alias}/mapper-types

pub async fn realm_identity_provider_instances_with_alias_mappers_post(
    &self,
    realm: &str,
    alias: &str,
    mapper: IdentityProviderMapperRepresentation<'_>
) -> Result<(), KeycloakError>
[src]

Add a mapper to identity provider POST /{realm}/identity-provider/instances/{alias}/mappers

pub async fn realm_identity_provider_instances_with_alias_mappers_get(
    &self,
    realm: &str,
    alias: &str
) -> Result<Vec<IdentityProviderMapperRepresentation<'static>>, KeycloakError>
[src]

Get mappers for identity provider GET /{realm}/identity-provider/instances/{alias}/mappers

pub async fn realm_identity_provider_instances_with_alias_mappers_with_id_get(
    &self,
    realm: &str,
    alias: &str,
    id: &str
) -> Result<IdentityProviderMapperRepresentation<'static>, KeycloakError>
[src]

Get mapper by id for the identity provider GET /{realm}/identity-provider/instances/{alias}/mappers/{id}

pub async fn realm_identity_provider_instances_with_alias_mappers_with_id_put(
    &self,
    realm: &str,
    alias: &str,
    id: &str,
    rep: IdentityProviderMapperRepresentation<'_>
) -> Result<(), KeycloakError>
[src]

Update a mapper for the identity provider PUT /{realm}/identity-provider/instances/{alias}/mappers/{id}

pub async fn realm_identity_provider_instances_with_alias_mappers_with_id_delete(
    &self,
    realm: &str,
    alias: &str,
    id: &str
) -> Result<(), KeycloakError>
[src]

Delete a mapper for the identity provider DELETE /{realm}/identity-provider/instances/{alias}/mappers/{id}

pub async fn realm_identity_provider_providers_with_provider_id_get(
    &self,
    realm: &str,
    provider_id: &str
) -> Result<(), KeycloakError>
[src]

Get identity providers GET /{realm}/identity-provider/providers/{provider_id}

pub async fn realm_keys_get(
    &self,
    realm: &str
) -> Result<KeysMetadataRepresentation<'static>, KeycloakError>
[src]

GET /{realm}/keys

pub async fn realm_client_scopes_with_id_protocol_mappers_add_models_post(
    &self,
    realm: &str,
    id: &str,
    reps: Vec<ProtocolMapperRepresentation<'_>>
) -> Result<(), KeycloakError>
[src]

Create multiple mappers POST /{realm}/client-scopes/{id}/protocol-mappers/add-models

pub async fn realm_client_scopes_with_id_protocol_mappers_models_post(
    &self,
    realm: &str,
    id: &str,
    rep: ProtocolMapperRepresentation<'_>
) -> Result<(), KeycloakError>
[src]

Create a mapper POST /{realm}/client-scopes/{id}/protocol-mappers/models

pub async fn realm_client_scopes_with_id_protocol_mappers_models_get(
    &self,
    realm: &str,
    id: &str
) -> Result<Vec<ProtocolMapperRepresentation<'static>>, KeycloakError>
[src]

Get mappers GET /{realm}/client-scopes/{id}/protocol-mappers/models

pub async fn realm_client_scopes_with_id_protocol_mappers_models_with_id_get(
    &self,
    realm: &str,
    id: &str
) -> Result<ProtocolMapperRepresentation<'static>, KeycloakError>
[src]

Get mapper by id GET /{realm}/client-scopes/{id}/protocol-mappers/models/{id}

pub async fn realm_client_scopes_with_id_protocol_mappers_models_with_id_put(
    &self,
    realm: &str,
    id: &str,
    rep: ProtocolMapperRepresentation<'_>
) -> Result<(), KeycloakError>
[src]

Update the mapper PUT /{realm}/client-scopes/{id}/protocol-mappers/models/{id}

pub async fn realm_client_scopes_with_id_protocol_mappers_models_with_id_delete(
    &self,
    realm: &str,
    id: &str
) -> Result<(), KeycloakError>
[src]

Delete the mapper DELETE /{realm}/client-scopes/{id}/protocol-mappers/models/{id}

pub async fn realm_client_scopes_with_id_protocol_mappers_protocol_with_protocol_get(
    &self,
    realm: &str,
    id: &str,
    protocol: &str
) -> Result<Vec<ProtocolMapperRepresentation<'static>>, KeycloakError>
[src]

Get mappers by name for a specific protocol GET /{realm}/client-scopes/{id}/protocol-mappers/protocol/{protocol}

pub async fn realm_clients_with_id_protocol_mappers_add_models_post(
    &self,
    realm: &str,
    id: &str,
    reps: Vec<ProtocolMapperRepresentation<'_>>
) -> Result<(), KeycloakError>
[src]

Create multiple mappers POST /{realm}/clients/{id}/protocol-mappers/add-models

pub async fn realm_clients_with_id_protocol_mappers_models_post(
    &self,
    realm: &str,
    id: &str,
    rep: ProtocolMapperRepresentation<'_>
) -> Result<(), KeycloakError>
[src]

Create a mapper POST /{realm}/clients/{id}/protocol-mappers/models

pub async fn realm_clients_with_id_protocol_mappers_models_get(
    &self,
    realm: &str,
    id: &str
) -> Result<Vec<ProtocolMapperRepresentation<'static>>, KeycloakError>
[src]

Get mappers GET /{realm}/clients/{id}/protocol-mappers/models

pub async fn realm_clients_with_id_protocol_mappers_models_with_id_get(
    &self,
    realm: &str,
    id: &str
) -> Result<ProtocolMapperRepresentation<'static>, KeycloakError>
[src]

Get mapper by id GET /{realm}/clients/{id}/protocol-mappers/models/{id}

pub async fn realm_clients_with_id_protocol_mappers_models_with_id_put(
    &self,
    realm: &str,
    id: &str,
    rep: ProtocolMapperRepresentation<'_>
) -> Result<(), KeycloakError>
[src]

Update the mapper PUT /{realm}/clients/{id}/protocol-mappers/models/{id}

pub async fn realm_clients_with_id_protocol_mappers_models_with_id_delete(
    &self,
    realm: &str,
    id: &str
) -> Result<(), KeycloakError>
[src]

Delete the mapper DELETE /{realm}/clients/{id}/protocol-mappers/models/{id}

pub async fn realm_clients_with_id_protocol_mappers_protocol_with_protocol_get(
    &self,
    realm: &str,
    id: &str,
    protocol: &str
) -> Result<Vec<ProtocolMapperRepresentation<'static>>, KeycloakError>
[src]

Get mappers by name for a specific protocol GET /{realm}/clients/{id}/protocol-mappers/protocol/{protocol}

pub async fn post(
    &self,
    rep: RealmRepresentation<'_>
) -> Result<(), KeycloakError>
[src]

Import a realm Imports a realm from a full representation of that realm. Realm name must be unique. POST /

pub async fn realm_get(
    &self,
    realm: &str
) -> Result<RealmRepresentation<'static>, KeycloakError>
[src]

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

pub async fn realm_put(
    &self,
    realm: &str,
    rep: RealmRepresentation<'_>
) -> Result<(), KeycloakError>
[src]

Update the top-level information of the realm Any user, roles or client information in the representation will be ignored. This will only update top-level attributes of the realm. PUT /{realm}

pub async fn realm_delete(&self, realm: &str) -> Result<(), KeycloakError>[src]

Delete the realm DELETE /{realm}

pub async fn realm_admin_events_get(
    &self,
    realm: &str,
    auth_client: Option<&str>,
    auth_ip_address: Option<&str>,
    auth_realm: Option<&str>,
    auth_user: Option<&str>,
    date_from: Option<&str>,
    date_to: Option<&str>,
    first: Option<i32>,
    max: Option<i32>,
    operation_types: Option<&str>,
    resource_path: Option<&str>,
    resource_types: Option<&str>
) -> Result<Vec<HashMap<Cow<'static, str>, Value>>, KeycloakError>
[src]

Get admin events Returns all admin events, or filters events based on URL query parameters listed here GET /{realm}/admin-events

pub async fn realm_admin_events_delete(
    &self,
    realm: &str
) -> Result<(), KeycloakError>
[src]

Delete all admin events DELETE /{realm}/admin-events

pub async fn realm_clear_keys_cache_post(
    &self,
    realm: &str
) -> Result<(), KeycloakError>
[src]

Clear cache of external public keys (Public keys of clients or Identity providers) POST /{realm}/clear-keys-cache

pub async fn realm_clear_realm_cache_post(
    &self,
    realm: &str
) -> Result<(), KeycloakError>
[src]

Clear realm cache POST /{realm}/clear-realm-cache

pub async fn realm_clear_user_cache_post(
    &self,
    realm: &str
) -> Result<(), KeycloakError>
[src]

Clear user cache POST /{realm}/clear-user-cache

pub async fn realm_client_description_converter_post(
    &self,
    realm: &str,
    description: &str
) -> Result<ClientRepresentation<'static>, KeycloakError>
[src]

Base path for importing clients under this realm. POST /{realm}/client-description-converter

pub async fn realm_client_session_stats_get(
    &self,
    realm: &str
) -> Result<Vec<HashMap<Cow<'static, str>, Value>>, KeycloakError>
[src]

Get client session stats Returns a JSON map. 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. GET /{realm}/client-session-stats

pub async fn realm_credential_registrators_get(
    &self,
    realm: &str
) -> Result<Vec<Cow<'static, str>>, KeycloakError>
[src]

GET /{realm}/credential-registrators

pub async fn realm_default_default_client_scopes_get(
    &self,
    realm: &str
) -> Result<Vec<ClientScopeRepresentation<'static>>, KeycloakError>
[src]

Get realm default client scopes. Only name and ids are returned. GET /{realm}/default-default-client-scopes

pub async fn realm_default_default_client_scopes_with_client_scope_id_put(
    &self,
    realm: &str,
    client_scope_id: &str
) -> Result<(), KeycloakError>
[src]

PUT /{realm}/default-default-client-scopes/{clientScopeId}

pub async fn realm_default_default_client_scopes_with_client_scope_id_delete(
    &self,
    realm: &str,
    client_scope_id: &str
) -> Result<(), KeycloakError>
[src]

DELETE /{realm}/default-default-client-scopes/{clientScopeId}

pub async fn realm_default_groups_get(
    &self,
    realm: &str
) -> Result<Vec<GroupRepresentation<'static>>, KeycloakError>
[src]

Get group hierarchy. Only name and ids are returned. GET /{realm}/default-groups

pub async fn realm_default_groups_with_group_id_put(
    &self,
    realm: &str,
    group_id: &str
) -> Result<(), KeycloakError>
[src]

PUT /{realm}/default-groups/{groupId}

pub async fn realm_default_groups_with_group_id_delete(
    &self,
    realm: &str,
    group_id: &str
) -> Result<(), KeycloakError>
[src]

DELETE /{realm}/default-groups/{groupId}

pub async fn realm_default_optional_client_scopes_get(
    &self,
    realm: &str
) -> Result<Vec<ClientScopeRepresentation<'static>>, KeycloakError>
[src]

Get realm optional client scopes. Only name and ids are returned. GET /{realm}/default-optional-client-scopes

pub async fn realm_default_optional_client_scopes_with_client_scope_id_put(
    &self,
    realm: &str,
    client_scope_id: &str
) -> Result<(), KeycloakError>
[src]

PUT /{realm}/default-optional-client-scopes/{clientScopeId}

pub async fn realm_default_optional_client_scopes_with_client_scope_id_delete(
    &self,
    realm: &str,
    client_scope_id: &str
) -> Result<(), KeycloakError>
[src]

DELETE /{realm}/default-optional-client-scopes/{clientScopeId}

pub async fn realm_events_get(
    &self,
    realm: &str,
    client: Option<&str>,
    date_from: Option<&str>,
    date_to: Option<&str>,
    first: Option<i32>,
    ip_address: Option<&str>,
    max: Option<i32>,
    type_: Option<&str>,
    user: Option<&str>
) -> Result<Vec<HashMap<Cow<'static, str>, Value>>, KeycloakError>
[src]

Get events Returns all events, or filters them based on URL query parameters listed here GET /{realm}/events

pub async fn realm_events_delete(
    &self,
    realm: &str
) -> Result<(), KeycloakError>
[src]

Delete all events DELETE /{realm}/events

pub async fn realm_events_config_get(
    &self,
    realm: &str
) -> Result<RealmEventsConfigRepresentation<'static>, KeycloakError>
[src]

Get the events provider configuration Returns JSON object with events provider configuration GET /{realm}/events/config

pub async fn realm_events_config_put(
    &self,
    realm: &str,
    rep: RealmEventsConfigRepresentation<'_>
) -> Result<(), KeycloakError>
[src]

Update the events provider Change the events provider and/or its configuration PUT /{realm}/events/config

pub async fn realm_group_by_path_with_path_get(
    &self,
    realm: &str,
    path: &str
) -> Result<GroupRepresentation<'static>, KeycloakError>
[src]

GET /{realm}/group-by-path/{path}

pub async fn realm_ldap_server_capabilities_post(
    &self,
    realm: &str,
    config: TestLdapConnectionRepresentation<'_>
) -> Result<(), KeycloakError>
[src]

Get LDAP supported extensions. POST /{realm}/ldap-server-capabilities

pub async fn realm_localization_get(
    &self,
    realm: &str
) -> Result<Vec<Cow<'static, str>>, KeycloakError>
[src]

GET /{realm}/localization

pub async fn realm_localization_with_locale_post(
    &self,
    realm: &str,
    locale: &str,
    input: &[u8]
) -> Result<(), KeycloakError>
[src]

Import localization from uploaded JSON file POST /{realm}/localization/{locale}

pub async fn realm_localization_with_locale_get(
    &self,
    realm: &str,
    locale: &str
) -> Result<HashMap<Cow<'static, str>, Value>, KeycloakError>
[src]

GET /{realm}/localization/{locale}

pub async fn realm_localization_with_locale_delete(
    &self,
    realm: &str,
    locale: &str
) -> Result<(), KeycloakError>
[src]

DELETE /{realm}/localization/{locale}

pub async fn realm_localization_with_locale_patch(
    &self,
    realm: &str,
    locale: &str,
    loclization_texts: HashMap<&str, Value>
) -> Result<(), KeycloakError>
[src]

PATCH /{realm}/localization/{locale}

pub async fn realm_localization_with_locale_with_key_get(
    &self,
    realm: &str,
    locale: &str,
    key: &str
) -> Result<Cow<'static, str>, KeycloakError>
[src]

GET /{realm}/localization/{locale}/{key}

pub async fn realm_localization_with_locale_with_key_put(
    &self,
    realm: &str,
    locale: &str,
    key: &str,
    text: &str
) -> Result<(), KeycloakError>
[src]

PUT /{realm}/localization/{locale}/{key}

pub async fn realm_localization_with_locale_with_key_delete(
    &self,
    realm: &str,
    locale: &str,
    key: &str
) -> Result<(), KeycloakError>
[src]

DELETE /{realm}/localization/{locale}/{key}

pub async fn realm_logout_all_post(
    &self,
    realm: &str
) -> Result<GlobalRequestResult<'static>, KeycloakError>
[src]

Removes all user sessions. Any client that has an admin url will also be told to invalidate any sessions they have. POST /{realm}/logout-all

pub async fn realm_partial_export_post(
    &self,
    realm: &str,
    export_clients: Option<bool>,
    export_groups_and_roles: Option<bool>
) -> Result<RealmRepresentation<'static>, KeycloakError>
[src]

Partial export of existing realm into a JSON file. POST /{realm}/partial-export

pub async fn realm_partial_import_post(
    &self,
    realm: &str,
    rep: PartialImportRepresentation<'_>
) -> Result<(), KeycloakError>
[src]

Partial import from a JSON file to an existing realm. POST /{realm}/partialImport

pub async fn realm_push_revocation_post(
    &self,
    realm: &str
) -> Result<GlobalRequestResult<'static>, KeycloakError>
[src]

Push the realm’s revocation policy to any client that has an admin url associated with it. POST /{realm}/push-revocation

pub async fn realm_sessions_with_session_delete(
    &self,
    realm: &str,
    session: &str
) -> Result<(), KeycloakError>
[src]

Remove a specific user session. Any client that has an admin url will also be told to invalidate this particular session. DELETE /{realm}/sessions/{session}

pub async fn realm_test_ldap_connection_post(
    &self,
    realm: &str,
    config: TestLdapConnectionRepresentation<'_>
) -> Result<(), KeycloakError>
[src]

Test LDAP connection POST /{realm}/testLDAPConnection

pub async fn realm_test_smtp_connection_post(
    &self,
    realm: &str,
    settings: HashMap<&str, Value>
) -> Result<(), KeycloakError>
[src]

POST /{realm}/testSMTPConnection

pub async fn realm_users_management_permissions_get(
    &self,
    realm: &str
) -> Result<ManagementPermissionReference<'static>, KeycloakError>
[src]

GET /{realm}/users-management-permissions

pub async fn realm_users_management_permissions_put(
    &self,
    realm: &str,
    ref_: ManagementPermissionReference<'_>
) -> Result<ManagementPermissionReference<'static>, KeycloakError>
[src]

PUT /{realm}/users-management-permissions

pub async fn realm_groups_with_id_role_mappings_get(
    &self,
    realm: &str,
    id: &str
) -> Result<MappingsRepresentation<'static>, KeycloakError>
[src]

Get role mappings GET /{realm}/groups/{id}/role-mappings

pub async fn realm_groups_with_id_role_mappings_realm_post(
    &self,
    realm: &str,
    id: &str,
    roles: Vec<RoleRepresentation<'_>>
) -> Result<(), KeycloakError>
[src]

Add realm-level role mappings to the user POST /{realm}/groups/{id}/role-mappings/realm

pub async fn realm_groups_with_id_role_mappings_realm_get(
    &self,
    realm: &str,
    id: &str
) -> Result<Vec<RoleRepresentation<'static>>, KeycloakError>
[src]

Get realm-level role mappings GET /{realm}/groups/{id}/role-mappings/realm

pub async fn realm_groups_with_id_role_mappings_realm_delete(
    &self,
    realm: &str,
    id: &str,
    roles: Vec<RoleRepresentation<'_>>
) -> Result<(), KeycloakError>
[src]

Delete realm-level role mappings DELETE /{realm}/groups/{id}/role-mappings/realm

pub async fn realm_groups_with_id_role_mappings_realm_available_get(
    &self,
    realm: &str,
    id: &str
) -> Result<Vec<RoleRepresentation<'static>>, KeycloakError>
[src]

Get realm-level roles that can be mapped GET /{realm}/groups/{id}/role-mappings/realm/available

pub async fn realm_groups_with_id_role_mappings_realm_composite_get(
    &self,
    realm: &str,
    id: &str,
    brief_representation: Option<bool>
) -> Result<Vec<RoleRepresentation<'static>>, KeycloakError>
[src]

Get effective realm-level role mappings This will recurse all composite roles to get the result. GET /{realm}/groups/{id}/role-mappings/realm/composite

pub async fn realm_users_with_id_role_mappings_get(
    &self,
    realm: &str,
    id: &str
) -> Result<MappingsRepresentation<'static>, KeycloakError>
[src]

Get role mappings GET /{realm}/users/{id}/role-mappings

pub async fn realm_users_with_id_role_mappings_realm_post(
    &self,
    realm: &str,
    id: &str,
    roles: Vec<RoleRepresentation<'_>>
) -> Result<(), KeycloakError>
[src]

Add realm-level role mappings to the user POST /{realm}/users/{id}/role-mappings/realm

pub async fn realm_users_with_id_role_mappings_realm_get(
    &self,
    realm: &str,
    id: &str
) -> Result<Vec<RoleRepresentation<'static>>, KeycloakError>
[src]

Get realm-level role mappings GET /{realm}/users/{id}/role-mappings/realm

pub async fn realm_users_with_id_role_mappings_realm_delete(
    &self,
    realm: &str,
    id: &str,
    roles: Vec<RoleRepresentation<'_>>
) -> Result<(), KeycloakError>
[src]

Delete realm-level role mappings DELETE /{realm}/users/{id}/role-mappings/realm

pub async fn realm_users_with_id_role_mappings_realm_available_get(
    &self,
    realm: &str,
    id: &str
) -> Result<Vec<RoleRepresentation<'static>>, KeycloakError>
[src]

Get realm-level roles that can be mapped GET /{realm}/users/{id}/role-mappings/realm/available

pub async fn realm_users_with_id_role_mappings_realm_composite_get(
    &self,
    realm: &str,
    id: &str,
    brief_representation: Option<bool>
) -> Result<Vec<RoleRepresentation<'static>>, KeycloakError>
[src]

Get effective realm-level role mappings This will recurse all composite roles to get the result. GET /{realm}/users/{id}/role-mappings/realm/composite

pub async fn realm_clients_with_id_roles_post(
    &self,
    realm: &str,
    id: &str,
    rep: RoleRepresentation<'_>
) -> Result<(), KeycloakError>
[src]

Create a new role for the realm or client POST /{realm}/clients/{id}/roles

pub async fn realm_clients_with_id_roles_get(
    &self,
    realm: &str,
    id: &str,
    brief_representation: Option<bool>,
    first: Option<i32>,
    max: Option<i32>,
    search: Option<&str>
) -> Result<Vec<RoleRepresentation<'static>>, KeycloakError>
[src]

Get all roles for the realm or client GET /{realm}/clients/{id}/roles

pub async fn realm_clients_with_id_roles_with_role_name_get(
    &self,
    realm: &str,
    id: &str,
    role_name: &str
) -> Result<RoleRepresentation<'static>, KeycloakError>
[src]

Get a role by name GET /{realm}/clients/{id}/roles/{role-name}

pub async fn realm_clients_with_id_roles_with_role_name_put(
    &self,
    realm: &str,
    id: &str,
    role_name: &str,
    rep: RoleRepresentation<'_>
) -> Result<(), KeycloakError>
[src]

Update a role by name PUT /{realm}/clients/{id}/roles/{role-name}

pub async fn realm_clients_with_id_roles_with_role_name_delete(
    &self,
    realm: &str,
    id: &str,
    role_name: &str
) -> Result<(), KeycloakError>
[src]

Delete a role by name DELETE /{realm}/clients/{id}/roles/{role-name}

pub async fn realm_clients_with_id_roles_with_role_name_composites_post(
    &self,
    realm: &str,
    id: &str,
    role_name: &str,
    roles: Vec<RoleRepresentation<'_>>
) -> Result<(), KeycloakError>
[src]

Add a composite to the role POST /{realm}/clients/{id}/roles/{role-name}/composites

pub async fn realm_clients_with_id_roles_with_role_name_composites_get(
    &self,
    realm: &str,
    id: &str,
    role_name: &str
) -> Result<Vec<RoleRepresentation<'static>>, KeycloakError>
[src]

Get composites of the role GET /{realm}/clients/{id}/roles/{role-name}/composites

pub async fn realm_clients_with_id_roles_with_role_name_composites_delete(
    &self,
    realm: &str,
    id: &str,
    role_name: &str,
    roles: Vec<RoleRepresentation<'_>>
) -> Result<(), KeycloakError>
[src]

Remove roles from the role’s composite DELETE /{realm}/clients/{id}/roles/{role-name}/composites

pub async fn realm_clients_with_id_roles_with_role_name_composites_clients_with_client_uuid_get(
    &self,
    realm: &str,
    id: &str,
    role_name: &str,
    client_uuid: &str
) -> Result<Vec<RoleRepresentation<'static>>, KeycloakError>
[src]

Get client-level roles for the client that are in the role’s composite GET /{realm}/clients/{id}/roles/{role-name}/composites/clients/{clientUuid}

pub async fn realm_clients_with_id_roles_with_role_name_composites_realm_get(
    &self,
    realm: &str,
    id: &str,
    role_name: &str
) -> Result<Vec<RoleRepresentation<'static>>, KeycloakError>
[src]

Get realm-level roles of the role’s composite GET /{realm}/clients/{id}/roles/{role-name}/composites/realm

pub async fn realm_clients_with_id_roles_with_role_name_groups_get(
    &self,
    realm: &str,
    id: &str,
    role_name: &str,
    brief_representation: Option<bool>,
    first: Option<i32>,
    max: Option<i32>
) -> Result<Vec<GroupRepresentation<'static>>, KeycloakError>
[src]

Returns a stream of groups that have the specified role name GET /{realm}/clients/{id}/roles/{role-name}/groups

pub async fn realm_clients_with_id_roles_with_role_name_management_permissions_get(
    &self,
    realm: &str,
    id: &str,
    role_name: &str
) -> Result<ManagementPermissionReference<'static>, KeycloakError>
[src]

Return object stating whether role Authorization permissions have been initialized or not and a reference GET /{realm}/clients/{id}/roles/{role-name}/management/permissions

pub async fn realm_clients_with_id_roles_with_role_name_management_permissions_put(
    &self,
    realm: &str,
    id: &str,
    role_name: &str,
    ref_: ManagementPermissionReference<'_>
) -> Result<ManagementPermissionReference<'static>, KeycloakError>
[src]

Return object stating whether role Authorization permissions have been initialized or not and a reference PUT /{realm}/clients/{id}/roles/{role-name}/management/permissions

pub async fn realm_clients_with_id_roles_with_role_name_users_get(
    &self,
    realm: &str,
    id: &str,
    role_name: &str,
    first: Option<i32>,
    max: Option<i32>
) -> Result<Vec<UserRepresentation<'static>>, KeycloakError>
[src]

Returns a stream of users that have the specified role name. GET /{realm}/clients/{id}/roles/{role-name}/users

pub async fn realm_roles_post(
    &self,
    realm: &str,
    rep: RoleRepresentation<'_>
) -> Result<(), KeycloakError>
[src]

Create a new role for the realm or client POST /{realm}/roles

pub async fn realm_roles_get(
    &self,
    realm: &str,
    brief_representation: Option<bool>,
    first: Option<i32>,
    max: Option<i32>,
    search: Option<&str>
) -> Result<Vec<RoleRepresentation<'static>>, KeycloakError>
[src]

Get all roles for the realm or client GET /{realm}/roles

pub async fn realm_roles_with_role_name_get(
    &self,
    realm: &str,
    role_name: &str
) -> Result<RoleRepresentation<'static>, KeycloakError>
[src]

Get a role by name GET /{realm}/roles/{role-name}

pub async fn realm_roles_with_role_name_put(
    &self,
    realm: &str,
    role_name: &str,
    rep: RoleRepresentation<'_>
) -> Result<(), KeycloakError>
[src]

Update a role by name PUT /{realm}/roles/{role-name}

pub async fn realm_roles_with_role_name_delete(
    &self,
    realm: &str,
    role_name: &str
) -> Result<(), KeycloakError>
[src]

Delete a role by name DELETE /{realm}/roles/{role-name}

pub async fn realm_roles_with_role_name_composites_post(
    &self,
    realm: &str,
    role_name: &str,
    roles: Vec<RoleRepresentation<'_>>
) -> Result<(), KeycloakError>
[src]

Add a composite to the role POST /{realm}/roles/{role-name}/composites

pub async fn realm_roles_with_role_name_composites_get(
    &self,
    realm: &str,
    role_name: &str
) -> Result<Vec<RoleRepresentation<'static>>, KeycloakError>
[src]

Get composites of the role GET /{realm}/roles/{role-name}/composites

pub async fn realm_roles_with_role_name_composites_delete(
    &self,
    realm: &str,
    role_name: &str,
    roles: Vec<RoleRepresentation<'_>>
) -> Result<(), KeycloakError>
[src]

Remove roles from the role’s composite DELETE /{realm}/roles/{role-name}/composites

pub async fn realm_roles_with_role_name_composites_clients_with_client_uuid_get(
    &self,
    realm: &str,
    role_name: &str,
    client_uuid: &str
) -> Result<Vec<RoleRepresentation<'static>>, KeycloakError>
[src]

Get client-level roles for the client that are in the role’s composite GET /{realm}/roles/{role-name}/composites/clients/{clientUuid}

pub async fn realm_roles_with_role_name_composites_realm_get(
    &self,
    realm: &str,
    role_name: &str
) -> Result<Vec<RoleRepresentation<'static>>, KeycloakError>
[src]

Get realm-level roles of the role’s composite GET /{realm}/roles/{role-name}/composites/realm

pub async fn realm_roles_with_role_name_groups_get(
    &self,
    realm: &str,
    role_name: &str,
    brief_representation: Option<bool>,
    first: Option<i32>,
    max: Option<i32>
) -> Result<Vec<GroupRepresentation<'static>>, KeycloakError>
[src]

Returns a stream of groups that have the specified role name GET /{realm}/roles/{role-name}/groups

pub async fn realm_roles_with_role_name_management_permissions_get(
    &self,
    realm: &str,
    role_name: &str
) -> Result<ManagementPermissionReference<'static>, KeycloakError>
[src]

Return object stating whether role Authorization permissions have been initialized or not and a reference GET /{realm}/roles/{role-name}/management/permissions

pub async fn realm_roles_with_role_name_management_permissions_put(
    &self,
    realm: &str,
    role_name: &str,
    ref_: ManagementPermissionReference<'_>
) -> Result<ManagementPermissionReference<'static>, KeycloakError>
[src]

Return object stating whether role Authorization permissions have been initialized or not and a reference PUT /{realm}/roles/{role-name}/management/permissions

pub async fn realm_roles_with_role_name_users_get(
    &self,
    realm: &str,
    role_name: &str,
    first: Option<i32>,
    max: Option<i32>
) -> Result<Vec<UserRepresentation<'static>>, KeycloakError>
[src]

Returns a stream of users that have the specified role name. GET /{realm}/roles/{role-name}/users

pub async fn realm_roles_by_id_with_role_id_get(
    &self,
    realm: &str,
    role_id: &str
) -> Result<RoleRepresentation<'static>, KeycloakError>
[src]

Get a specific role’s representation GET /{realm}/roles-by-id/{role-id}

pub async fn realm_roles_by_id_with_role_id_put(
    &self,
    realm: &str,
    role_id: &str,
    rep: RoleRepresentation<'_>
) -> Result<(), KeycloakError>
[src]

Update the role PUT /{realm}/roles-by-id/{role-id}

pub async fn realm_roles_by_id_with_role_id_delete(
    &self,
    realm: &str,
    role_id: &str
) -> Result<(), KeycloakError>
[src]

Delete the role DELETE /{realm}/roles-by-id/{role-id}

pub async fn realm_roles_by_id_with_role_id_composites_post(
    &self,
    realm: &str,
    role_id: &str,
    roles: Vec<RoleRepresentation<'_>>
) -> Result<(), KeycloakError>
[src]

Make the role a composite role by associating some child roles POST /{realm}/roles-by-id/{role-id}/composites

pub async fn realm_roles_by_id_with_role_id_composites_get(
    &self,
    realm: &str,
    role_id: &str
) -> Result<Vec<RoleRepresentation<'static>>, KeycloakError>
[src]

Get role’s children Returns a set of role’s children provided the role is a composite. GET /{realm}/roles-by-id/{role-id}/composites

pub async fn realm_roles_by_id_with_role_id_composites_delete(
    &self,
    realm: &str,
    role_id: &str,
    roles: Vec<RoleRepresentation<'_>>
) -> Result<(), KeycloakError>
[src]

Remove a set of roles from the role’s composite DELETE /{realm}/roles-by-id/{role-id}/composites

pub async fn realm_roles_by_id_with_role_id_composites_clients_with_client_uuid_get(
    &self,
    realm: &str,
    role_id: &str,
    client_uuid: &str
) -> Result<Vec<RoleRepresentation<'static>>, KeycloakError>
[src]

Get client-level roles for the client that are in the role’s composite GET /{realm}/roles-by-id/{role-id}/composites/clients/{clientUuid}

pub async fn realm_roles_by_id_with_role_id_composites_realm_get(
    &self,
    realm: &str,
    role_id: &str
) -> Result<Vec<RoleRepresentation<'static>>, KeycloakError>
[src]

Get realm-level roles that are in the role’s composite GET /{realm}/roles-by-id/{role-id}/composites/realm

pub async fn realm_roles_by_id_with_role_id_management_permissions_get(
    &self,
    realm: &str,
    role_id: &str
) -> Result<ManagementPermissionReference<'static>, KeycloakError>
[src]

Return object stating whether role Authoirzation permissions have been initialized or not and a reference GET /{realm}/roles-by-id/{role-id}/management/permissions

pub async fn realm_roles_by_id_with_role_id_management_permissions_put(
    &self,
    realm: &str,
    role_id: &str,
    ref_: ManagementPermissionReference<'_>
) -> Result<ManagementPermissionReference<'static>, KeycloakError>
[src]

Return object stating whether role Authoirzation permissions have been initialized or not and a reference PUT /{realm}/roles-by-id/{role-id}/management/permissions

pub async fn realm_client_scopes_with_id_scope_mappings_get(
    &self,
    realm: &str,
    id: &str
) -> Result<MappingsRepresentation<'static>, KeycloakError>
[src]

Get all scope mappings for the client GET /{realm}/client-scopes/{id}/scope-mappings

pub async fn realm_client_scopes_with_id_scope_mappings_clients_with_client_post(
    &self,
    realm: &str,
    id: &str,
    client: &str,
    roles: Vec<RoleRepresentation<'_>>
) -> Result<(), KeycloakError>
[src]

Add client-level roles to the client’s scope POST /{realm}/client-scopes/{id}/scope-mappings/clients/{client}

pub async fn realm_client_scopes_with_id_scope_mappings_clients_with_client_get(
    &self,
    realm: &str,
    id: &str,
    client: &str
) -> Result<Vec<RoleRepresentation<'static>>, KeycloakError>
[src]

Get the roles associated with a client’s scope Returns roles for the client. GET /{realm}/client-scopes/{id}/scope-mappings/clients/{client}

pub async fn realm_client_scopes_with_id_scope_mappings_clients_with_client_delete(
    &self,
    realm: &str,
    id: &str,
    client: &str,
    roles: Vec<RoleRepresentation<'_>>
) -> Result<(), KeycloakError>
[src]

Remove client-level roles from the client’s scope. DELETE /{realm}/client-scopes/{id}/scope-mappings/clients/{client}

pub async fn realm_client_scopes_with_id_scope_mappings_clients_with_client_available_get(
    &self,
    realm: &str,
    id: &str,
    client: &str
) -> Result<Vec<RoleRepresentation<'static>>, KeycloakError>
[src]

The available client-level roles Returns the roles for the client that can be associated with the client’s scope GET /{realm}/client-scopes/{id}/scope-mappings/clients/{client}/available

pub async fn realm_client_scopes_with_id_scope_mappings_clients_with_client_composite_get(
    &self,
    realm: &str,
    id: &str,
    client: &str,
    brief_representation: Option<bool>
) -> Result<Vec<RoleRepresentation<'static>>, KeycloakError>
[src]

Get effective client roles Returns the roles for the client that are associated with the client’s scope. GET /{realm}/client-scopes/{id}/scope-mappings/clients/{client}/composite

pub async fn realm_client_scopes_with_id_scope_mappings_realm_post(
    &self,
    realm: &str,
    id: &str,
    roles: Vec<RoleRepresentation<'_>>
) -> Result<(), KeycloakError>
[src]

Add a set of realm-level roles to the client’s scope POST /{realm}/client-scopes/{id}/scope-mappings/realm

pub async fn realm_client_scopes_with_id_scope_mappings_realm_get(
    &self,
    realm: &str,
    id: &str
) -> Result<Vec<RoleRepresentation<'static>>, KeycloakError>
[src]

Get realm-level roles associated with the client’s scope GET /{realm}/client-scopes/{id}/scope-mappings/realm

pub async fn realm_client_scopes_with_id_scope_mappings_realm_delete(
    &self,
    realm: &str,
    id: &str,
    roles: Vec<RoleRepresentation<'_>>
) -> Result<(), KeycloakError>
[src]

Remove a set of realm-level roles from the client’s scope DELETE /{realm}/client-scopes/{id}/scope-mappings/realm

pub async fn realm_client_scopes_with_id_scope_mappings_realm_available_get(
    &self,
    realm: &str,
    id: &str
) -> Result<Vec<RoleRepresentation<'static>>, KeycloakError>
[src]

Get realm-level roles that are available to attach to this client’s scope GET /{realm}/client-scopes/{id}/scope-mappings/realm/available

pub async fn realm_client_scopes_with_id_scope_mappings_realm_composite_get(
    &self,
    realm: &str,
    id: &str,
    brief_representation: Option<bool>
) -> Result<Vec<RoleRepresentation<'static>>, KeycloakError>
[src]

Get effective realm-level roles associated with the client’s scope What this does is recurse any composite roles associated with the client’s scope and adds the roles to this lists. The method is really to show a comprehensive total view of realm-level roles associated with the client. GET /{realm}/client-scopes/{id}/scope-mappings/realm/composite

pub async fn realm_clients_with_id_scope_mappings_get(
    &self,
    realm: &str,
    id: &str
) -> Result<MappingsRepresentation<'static>, KeycloakError>
[src]

Get all scope mappings for the client GET /{realm}/clients/{id}/scope-mappings

pub async fn realm_clients_with_id_scope_mappings_clients_with_client_post(
    &self,
    realm: &str,
    id: &str,
    client: &str,
    roles: Vec<RoleRepresentation<'_>>
) -> Result<(), KeycloakError>
[src]

Add client-level roles to the client’s scope POST /{realm}/clients/{id}/scope-mappings/clients/{client}

pub async fn realm_clients_with_id_scope_mappings_clients_with_client_get(
    &self,
    realm: &str,
    id: &str,
    client: &str
) -> Result<Vec<RoleRepresentation<'static>>, KeycloakError>
[src]

Get the roles associated with a client’s scope Returns roles for the client. GET /{realm}/clients/{id}/scope-mappings/clients/{client}

pub async fn realm_clients_with_id_scope_mappings_clients_with_client_delete(
    &self,
    realm: &str,
    id: &str,
    client: &str,
    roles: Vec<RoleRepresentation<'_>>
) -> Result<(), KeycloakError>
[src]

Remove client-level roles from the client’s scope. DELETE /{realm}/clients/{id}/scope-mappings/clients/{client}

pub async fn realm_clients_with_id_scope_mappings_clients_with_client_available_get(
    &self,
    realm: &str,
    id: &str,
    client: &str
) -> Result<Vec<RoleRepresentation<'static>>, KeycloakError>
[src]

The available client-level roles Returns the roles for the client that can be associated with the client’s scope GET /{realm}/clients/{id}/scope-mappings/clients/{client}/available

pub async fn realm_clients_with_id_scope_mappings_clients_with_client_composite_get(
    &self,
    realm: &str,
    id: &str,
    client: &str,
    brief_representation: Option<bool>
) -> Result<Vec<RoleRepresentation<'static>>, KeycloakError>
[src]

Get effective client roles Returns the roles for the client that are associated with the client’s scope. GET /{realm}/clients/{id}/scope-mappings/clients/{client}/composite

pub async fn realm_clients_with_id_scope_mappings_realm_post(
    &self,
    realm: &str,
    id: &str,
    roles: Vec<RoleRepresentation<'_>>
) -> Result<(), KeycloakError>
[src]

Add a set of realm-level roles to the client’s scope POST /{realm}/clients/{id}/scope-mappings/realm

pub async fn realm_clients_with_id_scope_mappings_realm_get(
    &self,
    realm: &str,
    id: &str
) -> Result<Vec<RoleRepresentation<'static>>, KeycloakError>
[src]

Get realm-level roles associated with the client’s scope GET /{realm}/clients/{id}/scope-mappings/realm

pub async fn realm_clients_with_id_scope_mappings_realm_delete(
    &self,
    realm: &str,
    id: &str,
    roles: Vec<RoleRepresentation<'_>>
) -> Result<(), KeycloakError>
[src]

Remove a set of realm-level roles from the client’s scope DELETE /{realm}/clients/{id}/scope-mappings/realm

pub async fn realm_clients_with_id_scope_mappings_realm_available_get(
    &self,
    realm: &str,
    id: &str
) -> Result<Vec<RoleRepresentation<'static>>, KeycloakError>
[src]

Get realm-level roles that are available to attach to this client’s scope GET /{realm}/clients/{id}/scope-mappings/realm/available

pub async fn realm_clients_with_id_scope_mappings_realm_composite_get(
    &self,
    realm: &str,
    id: &str,
    brief_representation: Option<bool>
) -> Result<Vec<RoleRepresentation<'static>>, KeycloakError>
[src]

Get effective realm-level roles associated with the client’s scope What this does is recurse any composite roles associated with the client’s scope and adds the roles to this lists. The method is really to show a comprehensive total view of realm-level roles associated with the client. GET /{realm}/clients/{id}/scope-mappings/realm/composite

pub async fn with_id_name_get(
    &self,
    id: &str
) -> Result<HashMap<Cow<'static, str>, Value>, KeycloakError>
[src]

Need this for admin console to display simple name of provider when displaying client detail KEYCLOAK-4328 GET /{id}/name

pub async fn realm_user_storage_with_id_name_get(
    &self,
    realm: &str,
    id: &str
) -> Result<HashMap<Cow<'static, str>, Value>, KeycloakError>
[src]

Need this for admin console to display simple name of provider when displaying user detail KEYCLOAK-4328 GET /{realm}/user-storage/{id}/name

pub async fn realm_user_storage_with_id_remove_imported_users_post(
    &self,
    realm: &str,
    id: &str
) -> Result<(), KeycloakError>
[src]

Remove imported users POST /{realm}/user-storage/{id}/remove-imported-users

pub async fn realm_user_storage_with_id_sync_post(
    &self,
    realm: &str,
    id: &str,
    action: Option<&str>
) -> Result<SynchronizationResult<'static>, KeycloakError>
[src]

Trigger sync of users Action can be "triggerFullSync" or "triggerChangedUsersSync" POST /{realm}/user-storage/{id}/sync

pub async fn realm_user_storage_with_id_unlink_users_post(
    &self,
    realm: &str,
    id: &str
) -> Result<(), KeycloakError>
[src]

Unlink imported users from a storage provider POST /{realm}/user-storage/{id}/unlink-users

pub async fn realm_user_storage_with_parent_id_mappers_with_id_sync_post(
    &self,
    realm: &str,
    parent_id: &str,
    id: &str,
    direction: Option<&str>
) -> Result<SynchronizationResult<'static>, KeycloakError>
[src]

Trigger sync of mapper data related to ldap mapper (roles, groups, …​) direction is "fedToKeycloak" or "keycloakToFed" POST /{realm}/user-storage/{parentId}/mappers/{id}/sync

pub async fn realm_users_post(
    &self,
    realm: &str,
    rep: UserRepresentation<'_>
) -> Result<(), KeycloakError>
[src]

Create a new user Username must be unique. POST /{realm}/users

pub async fn realm_users_get(
    &self,
    realm: &str,
    brief_representation: Option<bool>,
    email: Option<&str>,
    email_verified: Option<bool>,
    enabled: Option<bool>,
    exact: Option<bool>,
    first: Option<i32>,
    first_name: Option<&str>,
    idp_alias: Option<&str>,
    idp_user_id: Option<&str>,
    last_name: Option<&str>,
    max: Option<i32>,
    search: Option<&str>,
    username: Option<&str>
) -> Result<Vec<UserRepresentation<'static>>, KeycloakError>
[src]

Get users Returns a stream of users, filtered according to query parameters GET /{realm}/users

pub async fn realm_users_count_get(
    &self,
    realm: &str,
    email: Option<&str>,
    email_verified: Option<bool>,
    first_name: Option<&str>,
    last_name: Option<&str>,
    search: Option<&str>,
    username: Option<&str>
) -> Result<i32, KeycloakError>
[src]

Returns the number of users that match the given criteria. 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 criteria are matched against their respective fields on a user entity. Combined with a logical and. GET /{realm}/users/count

pub async fn realm_users_with_id_get(
    &self,
    realm: &str,
    id: &str
) -> Result<UserRepresentation<'static>, KeycloakError>
[src]

Get representation of the user GET /{realm}/users/{id}

pub async fn realm_users_with_id_put(
    &self,
    realm: &str,
    id: &str,
    rep: UserRepresentation<'_>
) -> Result<(), KeycloakError>
[src]

Update the user PUT /{realm}/users/{id}

pub async fn realm_users_with_id_delete(
    &self,
    realm: &str,
    id: &str
) -> Result<(), KeycloakError>
[src]

Delete the user DELETE /{realm}/users/{id}

pub async fn realm_users_with_id_configured_user_storage_credential_types_get(
    &self,
    realm: &str,
    id: &str
) -> Result<Vec<Cow<'static, str>>, KeycloakError>
[src]

Return credential types, which are provided by the user storage where user is stored. 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 GET /{realm}/users/{id}/configured-user-storage-credential-types

pub async fn realm_users_with_id_consents_get(
    &self,
    realm: &str,
    id: &str
) -> Result<Vec<HashMap<Cow<'static, str>, Value>>, KeycloakError>
[src]

Get consents granted by the user GET /{realm}/users/{id}/consents

pub async fn realm_users_with_id_consents_with_client_delete(
    &self,
    realm: &str,
    id: &str,
    client: &str
) -> Result<(), KeycloakError>
[src]

Revoke consent and offline tokens for particular client from user DELETE /{realm}/users/{id}/consents/{client}

pub async fn realm_users_with_id_credentials_get(
    &self,
    realm: &str,
    id: &str
) -> Result<Vec<CredentialRepresentation<'static>>, KeycloakError>
[src]

GET /{realm}/users/{id}/credentials

pub async fn realm_users_with_id_credentials_with_credential_id_delete(
    &self,
    realm: &str,
    id: &str,
    credential_id: &str
) -> Result<(), KeycloakError>
[src]

Remove a credential for a user DELETE /{realm}/users/{id}/credentials/{credentialId}

pub async fn realm_users_with_id_credentials_with_credential_id_move_after_with_new_previous_credential_id_post(
    &self,
    realm: &str,
    id: &str,
    credential_id: &str,
    new_previous_credential_id: &str
) -> Result<(), KeycloakError>
[src]

Move a credential to a position behind another credential POST /{realm}/users/{id}/credentials/{credentialId}/moveAfter/{newPreviousCredentialId}

pub async fn realm_users_with_id_credentials_with_credential_id_move_to_first_post(
    &self,
    realm: &str,
    id: &str,
    credential_id: &str
) -> Result<(), KeycloakError>
[src]

Move a credential to a first position in the credentials list of the user POST /{realm}/users/{id}/credentials/{credentialId}/moveToFirst

pub async fn realm_users_with_id_credentials_with_credential_id_user_label_put(
    &self,
    realm: &str,
    id: &str,
    credential_id: &str,
    user_label: &str
) -> Result<(), KeycloakError>
[src]

Update a credential label for a user PUT /{realm}/users/{id}/credentials/{credentialId}/userLabel

pub async fn realm_users_with_id_disable_credential_types_put(
    &self,
    realm: &str,
    id: &str,
    credential_types: Vec<&str>
) -> Result<(), KeycloakError>
[src]

Disable all credentials for a user of a specific type PUT /{realm}/users/{id}/disable-credential-types

pub async fn realm_users_with_id_execute_actions_email_put(
    &self,
    realm: &str,
    id: &str,
    client_id: Option<&str>,
    lifespan: Option<i32>,
    redirect_uri: Option<&str>,
    actions: Vec<&str>
) -> Result<(), KeycloakError>
[src]

Send a update account email to the user An email contains a link the user can click to perform a set of required actions. The redirectUri and clientId parameters are optional. If no redirect is given, then there will be no link back to click after actions have completed. Redirect uri must be a valid uri for the particular clientId. PUT /{realm}/users/{id}/execute-actions-email

pub async fn realm_users_with_id_federated_identity_get(
    &self,
    realm: &str,
    id: &str
) -> Result<Vec<FederatedIdentityRepresentation<'static>>, KeycloakError>
[src]

Get social logins associated with the user GET /{realm}/users/{id}/federated-identity

pub async fn realm_users_with_id_federated_identity_with_provider_post(
    &self,
    realm: &str,
    id: &str,
    provider: &str,
    rep: FederatedIdentityRepresentation<'_>
) -> Result<(), KeycloakError>
[src]

Add a social login provider to the user POST /{realm}/users/{id}/federated-identity/{provider}

pub async fn realm_users_with_id_federated_identity_with_provider_delete(
    &self,
    realm: &str,
    id: &str,
    provider: &str
) -> Result<(), KeycloakError>
[src]

Remove a social login provider from user DELETE /{realm}/users/{id}/federated-identity/{provider}

pub async fn realm_users_with_id_groups_get(
    &self,
    realm: &str,
    id: &str,
    brief_representation: Option<bool>,
    first: Option<i32>,
    max: Option<i32>,
    search: Option<&str>
) -> Result<Vec<GroupRepresentation<'static>>, KeycloakError>
[src]

GET /{realm}/users/{id}/groups

pub async fn realm_users_with_id_groups_count_get(
    &self,
    realm: &str,
    id: &str,
    search: Option<&str>
) -> Result<HashMap<Cow<'static, str>, Value>, KeycloakError>
[src]

GET /{realm}/users/{id}/groups/count

pub async fn realm_users_with_id_groups_with_group_id_put(
    &self,
    realm: &str,
    id: &str,
    group_id: &str
) -> Result<(), KeycloakError>
[src]

PUT /{realm}/users/{id}/groups/{groupId}

pub async fn realm_users_with_id_groups_with_group_id_delete(
    &self,
    realm: &str,
    id: &str,
    group_id: &str
) -> Result<(), KeycloakError>
[src]

DELETE /{realm}/users/{id}/groups/{groupId}

pub async fn realm_users_with_id_impersonation_post(
    &self,
    realm: &str,
    id: &str
) -> Result<HashMap<Cow<'static, str>, Value>, KeycloakError>
[src]

Impersonate the user POST /{realm}/users/{id}/impersonation

pub async fn realm_users_with_id_logout_post(
    &self,
    realm: &str,
    id: &str
) -> Result<(), KeycloakError>
[src]

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. POST /{realm}/users/{id}/logout

pub async fn realm_users_with_id_offline_sessions_with_client_uuid_get(
    &self,
    realm: &str,
    id: &str,
    client_uuid: &str
) -> Result<Vec<HashMap<Cow<'static, str>, Value>>, KeycloakError>
[src]

Get offline sessions associated with the user and client GET /{realm}/users/{id}/offline-sessions/{clientUuid}

pub async fn realm_users_with_id_reset_password_put(
    &self,
    realm: &str,
    id: &str,
    cred: CredentialRepresentation<'_>
) -> Result<(), KeycloakError>
[src]

Set up a new password for the user. PUT /{realm}/users/{id}/reset-password

pub async fn realm_users_with_id_send_verify_email_put(
    &self,
    realm: &str,
    id: &str,
    client_id: Option<&str>,
    redirect_uri: Option<&str>
) -> Result<(), KeycloakError>
[src]

Send an email-verification email to the user An email contains a link the user can click to verify their email address. The redirectUri and clientId parameters are optional. The default for the redirect is the account client. PUT /{realm}/users/{id}/send-verify-email

pub async fn realm_users_with_id_sessions_get(
    &self,
    realm: &str,
    id: &str
) -> Result<Vec<HashMap<Cow<'static, str>, Value>>, KeycloakError>
[src]

Get sessions associated with the user GET /{realm}/users/{id}/sessions

pub async fn get(
    &self
) -> Result<ServerInfoRepresentation<'static>, KeycloakError>
[src]

Get themes, social providers, auth providers, and event listeners available on this server GET /

pub async fn any_options(&self) -> Result<(), KeycloakError>[src]

CORS preflight OPTIONS /{any}

impl<'a> KeycloakAdmin<'a>[src]

pub fn new(
    url: &str,
    admin_token: KeycloakAdminToken<'a>,
    client: Client
) -> Self
[src]

Auto Trait Implementations

impl<'a> !RefUnwindSafe for KeycloakAdmin<'a>[src]

impl<'a> Send for KeycloakAdmin<'a>[src]

impl<'a> Sync for KeycloakAdmin<'a>[src]

impl<'a> Unpin for KeycloakAdmin<'a>[src]

impl<'a> !UnwindSafe for KeycloakAdmin<'a>[src]

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T> Instrument for T[src]

impl<T> Instrument for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.