awsapilib.sso.entities package¶

Submodules¶

awsapilib.sso.entities.entities module¶

Main code for entities.

class awsapilib.sso.entities.entities.Account(sso_instance, data)[source]¶

Bases: Entity

Models the Account object of AWS SSO.

property arn¶

The arn of the application.

Returns:: The arn of the application
Return type:: arn (str)

property associated_profiles¶

The associated profiles with the Account.

Returns:: The profiles associated with the Account
Return type:: associated_profiles (list)

property email¶

The name of the application.

Returns:: The name of the application
Return type:: email (str)

property id¶

The id of the application.

Returns:: The id of the application
Return type:: id (str)

property instance_id¶

The instance id of the Account.

Returns:: The instance id of the account
Return type:: instance_id (str)

property name¶

The name of the application.

Returns:: The name of the application
Return type:: name (str)

provision_saml_provider()[source]¶

Creates the SAMl provider.

Returns:: The arn of the SAMl provider
Return type:: arn (str)

property status¶

The status of the application.

Returns:: The status of the application
Return type:: status (str)

property url¶

Url for the account.

Returns:: The url of the account
Return type:: url (str)

class awsapilib.sso.entities.entities.Entity(sso_instance, data)[source]¶

Bases: LoggerMixin

The core entity.

class awsapilib.sso.entities.entities.Group(sso_instance, data)[source]¶

Bases: Entity

Models the group object of AWS SSO.

property description¶

The description of the group.

Returns:: The description of the group
Return type:: description (str)

property id¶

The id of the group.

Returns:: The id of the group
Return type:: id (str)

property name¶

The name of the group.

Returns:: The name of the group
Return type:: name (str)

property users¶

The users in the group.

Returns:: The users part of the group
Return type:: users (list)

class awsapilib.sso.entities.entities.PermissionSet(sso_instance, data)[source]¶

Bases: Entity

Models the permission set object of SSO.

assign_custom_policy_to_permission_set(policy_document)[source]¶

Assign Custom policy to a permission_set.

Parameters:

permission_set_name – The name of the permission_set .
policy_document – The policy for the permission_set

Returns:

True or False

Return type:

Bool

property creation_date¶

The creation date of the permission set.

Returns:: The creation date of the permission set
Return type:: creation_date (str)

delete_custom_policy_from_permission_set()[source]¶

Assign Custom policy to a permission_set.

Returns:: True or False
Return type:: Bool

property description¶

The description of the permission set.

Returns:: The description of the permission set
Return type:: description (str)

property id¶

The id of the permission set.

Returns:: The id of the permission set
Return type:: id (str)

property name¶

The name of the permission set.

Returns:: The name of the permission set
Return type:: name (str)

property permission_policy¶

The permission policy of the permission_set.

Returns:: The permission policy of the permission_set
Return type:: permission_policy (dict)

property provisioned_accounts¶

The provisioned accounts with the permission set.

Returns:: Accounts provisioned with the permission set
Return type:: list

property relay_state¶

The relay_state of the permission_set.

Returns:: The relayState of the permission_set
Return type:: relay_state (str)

property ttl¶

The ttl of the permission set.

Returns:: The ttl of the permission set
Return type:: ttl (str)

update(description=' ', relay_state='', ttl='')[source]¶

The relayState of the permission_set.

Parameters:

description – Description for the permission set
relay_state – The relay state for the permission set. https://docs.aws.amazon.com/singlesignon/latest/userguide/howtopermrelaystate.html
ttl – session duration

Returns:

True or False

Return type:

bool

property url¶

Url of the permission set.

Returns:: The url of the permission set
Return type:: url (str)

class awsapilib.sso.entities.entities.User(sso_instance, data)[source]¶

Bases: Entity

Models the user object of SSO.

property created_at¶

The date and time of the users’s activation.

Returns:: The datetime object of when the user was activated
Return type:: created_at (datetime)

property display_name¶

The display name of the user.

Returns:: The display name of the user
Return type:: display_name (str)

property emails¶

The date and time of the users’s last password change.

Returns:: The datetime object of when the user last changed password
Return type:: emails (datetime)

property first_name¶

The first name of the user.

Returns:: The first name of the user
Return type:: first_name (str)

property groups¶

The groups associated with the user.

Returns:: The groups associated with the user
Return type:: groups (list)

property id¶

The manager of the user.

Returns:: The manager of the user
Return type:: id (str)

property last_name¶

The last name of the user.

Returns:: The last name of the user
Return type:: last_name (str)

property name¶

The manager of the user.

Returns:: The manager of the user
Return type:: name (str)

property status¶

The status of the user.

Returns:: The status of the user
Return type:: status (str)

property updated_at¶

The date and time of the users’s status change.

Returns:: The datetime object of when the user had last changed status
Return type:: updated_at (datetime)

property url¶

Url for the user.

Returns:: The url for the user
Return type:: url (str)

Module contents¶

entities package.

Import all parts from entities here