keystone.identity.shadow_backends package

Submodules

keystone.identity.shadow_backends.base module

class keystone.identity.shadow_backends.base.ShadowUsersDriverBase[source]

Bases: object

Interface description for an Shadow Users driver.

create_federated_user(domain_id, federated_dict)[source]

Create a new user with the federated identity.

Parameters:
  • domain_id – The domain ID of the IdP used for the federated user
  • federated_dict (dict) – Reference to the federated user
Returns dict:

Containing the user reference
create_nonlocal_user(user_dict)[source]

Create a new non-local user.

Parameters:user_dict (dict) – Reference to the non-local user
Returns dict:Containing the user reference
get_federated_user(idp_id, protocol_id, unique_id)[source]

Return the found user for the federated identity.

Parameters:
  • idp_id – The identity provider ID
  • protocol_id – The federation protocol ID
  • unique_id – The unique ID for the user
Returns dict:

Containing the user reference
get_user(user_id)[source]

Return the found user.

Parameters:user_id – Unique identifier of the user
Returns dict:Containing the user reference
set_last_active_at(user_id)[source]

Set the last active at date for the user.

Parameters:user_id – Unique identifier of the user
update_federated_user_display_name(idp_id, protocol_id, unique_id, display_name)[source]

Update federated user’s display name if changed.

Parameters:
  • idp_id – The identity provider ID
  • protocol_id – The federation protocol ID
  • unique_id – The unique ID for the user
  • display_name – The user’s display name

keystone.identity.shadow_backends.sql module

class keystone.identity.shadow_backends.sql.ShadowUsers[source]

Bases: keystone.identity.shadow_backends.base.ShadowUsersDriverBase

create_federated_user(*args, **kwargs)[source]
create_nonlocal_user(*args, **kwargs)[source]
get_federated_user(idp_id, protocol_id, unique_id)[source]
get_federated_users(hints)[source]
get_user(user_id)[source]
set_last_active_at(user_id)[source]
update_federated_user_display_name(*args, **kwargs)[source]

Module contents