yellowdog_client.account – Account

All functionality is accessed via:

• the yellowdog_client.account.AccountClient

• the yellowdog_client.account.ApplicationClient

• the yellowdog_client.account.KeyringClient

class yellowdog_client.account.AccountClient

The API interface exposed by the YellowDog Account Service

abstractmethod add_application(request)

Parameters:

request (AddApplicationRequest)

Return type:

AddApplicationResponse

abstractmethod add_application_to_group(group_id, application_id)

Parameters:

• group_id (str)

• application_id (str)

Return type:

None

abstractmethod add_group(request)

Parameters:

request (AddGroupRequest)

Return type:

Group

abstractmethod add_role_to_group(group_id, role_id, scope)

Parameters:

• group_id (str)

• role_id (str)

• scope (RoleScope)

Return type:

None

abstractmethod add_user_to_group(group_id, user_id)

Parameters:

• group_id (str)

• user_id (str)

Return type:

None

abstractmethod delete_application(application_id)

Parameters:

application_id (str)

Return type:

None

abstractmethod delete_group(group_id)

Parameters:

group_id (str)

Return type:

None

abstractmethod get_application(application_id)

Parameters:

application_id (str)

Return type:

Application

abstractmethod get_application_groups(application_id)

Parameters:

application_id (str)

Return type:

SearchClient[GroupSummary]

abstractmethod get_applications(search)

Parameters:

search (ApplicationSearch)

Return type:

SearchClient[Application]

abstractmethod get_group(group_id)

Parameters:

group_id (str)

Return type:

Group

abstractmethod get_group_applications(group_id)

Parameters:

group_id (str)

Return type:

SearchClient[Application]

abstractmethod get_group_roles(group_id)

Parameters:

group_id (str)

Return type:

SearchClient[Role]

abstractmethod get_group_users(group_id)

Parameters:

group_id (str)

Return type:

SearchClient[User]

abstractmethod get_groups(search)

Parameters:

search (GroupSearch)

Return type:

SearchClient[GroupSummary]

abstractmethod get_role(role_id)

Parameters:

role_id (str)

Return type:

Role

abstractmethod get_role_groups(role_id)

Parameters:

role_id (str)

Return type:

SearchClient[GroupSummary]

abstractmethod get_roles(search)

Parameters:

search (RoleSearch)

Return type:

SearchClient[Role]

abstractmethod get_user(user_id)

Parameters:

user_id (str)

Return type:

User

abstractmethod get_user_groups(user_id)

Parameters:

user_id (str)

Return type:

SearchClient[GroupSummary]

abstractmethod get_users(search)

Parameters:

search (UserSearch)

Return type:

SearchClient[User]

abstractmethod list_permissions()

Return type:

List[PermissionDetail]

abstractmethod regenerate_application_api_key(application_id)

Parameters:

application_id (str)

Return type:

ApiKey

abstractmethod remove_application_from_group(group_id, application_id)

Parameters:

• group_id (str)

• application_id (str)

Return type:

None

abstractmethod remove_role_from_group(group_id, role_id)

Parameters:

• group_id (str)

• role_id (str)

Return type:

None

abstractmethod remove_user_from_group(group_id, user_id)

Parameters:

• group_id (str)

• user_id (str)

Return type:

None

abstractmethod update_application(application_id, request)

Parameters:

• application_id (str)

• request (UpdateApplicationRequest)

Return type:

Application

abstractmethod update_group(group_id, request)

Parameters:

• group_id (str)

• request (UpdateGroupRequest)

Return type:

Group

class yellowdog_client.account.AccountClientImpl(service_proxy)

Parameters:

service_proxy (AccountServiceProxy)

add_application(request)

Parameters:

request (AddApplicationRequest)

Return type:

AddApplicationResponse

add_application_to_group(group_id, application_id)

Parameters:

• group_id (str)

• application_id (str)

Return type:

None

add_group(request)

Parameters:

request (AddGroupRequest)

Return type:

Group

add_role_to_group(group_id, role_id, scope)

Parameters:

• group_id (str)

• role_id (str)

• scope (RoleScope)

Return type:

None

add_user_to_group(group_id, user_id)

Parameters:

• group_id (str)

• user_id (str)

Return type:

None

close()

delete_application(application_id)

Parameters:

application_id (str)

Return type:

None

delete_group(group_id)

Parameters:

group_id (str)

Return type:

None

get_application(application_id)

Parameters:

application_id (str)

Return type:

Application

get_application_groups(application_id)

Parameters:

application_id (str)

Return type:

SearchClient[GroupSummary]

get_applications(search)

Parameters:

search (ApplicationSearch)

Return type:

SearchClient[Application]

get_group(group_id)

Parameters:

group_id (str)

Return type:

Group

get_group_applications(group_id)

Parameters:

group_id (str)

Return type:

SearchClient[Application]

get_group_roles(group_id)

Parameters:

group_id (str)

Return type:

SearchClient[Role]

get_group_users(group_id)

Parameters:

group_id (str)

Return type:

SearchClient[User]

get_groups(search)

Parameters:

search (GroupSearch)

Return type:

SearchClient[GroupSummary]

get_role(role_id)

Parameters:

role_id (str)

Return type:

Role

get_role_groups(role_id)

Parameters:

role_id (str)

Return type:

SearchClient[GroupSummary]

get_roles(search)

Parameters:

search (RoleSearch)

Return type:

SearchClient[Role]

get_user(user_id)

Parameters:

user_id (str)

Return type:

User

get_user_groups(user_id)

Parameters:

user_id (str)

Return type:

SearchClient[GroupSummary]

get_users(search)

Parameters:

search (UserSearch)

Return type:

SearchClient[User]

list_permissions()

Return type:

List[PermissionDetail]

regenerate_application_api_key(application_id)

Parameters:

application_id (str)

Return type:

ApiKey

remove_application_from_group(group_id, application_id)

Parameters:

• group_id (str)

• application_id (str)

Return type:

None

remove_role_from_group(group_id, role_id)

Parameters:

• group_id (str)

• role_id (str)

Return type:

None

remove_user_from_group(group_id, user_id)

Parameters:

• group_id (str)

• user_id (str)

Return type:

None

update_application(application_id, request)

Parameters:

• application_id (str)

• request (UpdateApplicationRequest)

Return type:

Application

update_group(group_id, request)

Parameters:

• group_id (str)

• request (UpdateGroupRequest)

Return type:

Group

class yellowdog_client.account.AccountServiceProxy(proxy)

Parameters:

proxy (Proxy)

add_application(request)

Parameters:

request (AddApplicationRequest)

Return type:

AddApplicationResponse

add_application_to_group(group_id, application_id)

Parameters:

• group_id (str)

• application_id (str)

Return type:

None

add_group(request)

Parameters:

request (AddGroupRequest)

Return type:

Group

add_role_to_group(group_id, role_id, scope)

Parameters:

• group_id (str)

• role_id (str)

• scope (RoleScope)

Return type:

None

add_user_to_group(group_id, user_id)

Parameters:

• group_id (str)

• user_id (str)

Return type:

None

delete_application(application_id)

Parameters:

application_id (str)

Return type:

None

delete_group(group_id)

Parameters:

group_id (str)

Return type:

None

get_application(application_id)

Parameters:

application_id (str)

Return type:

Application

get_group(group_id)

Parameters:

group_id (str)

Return type:

Group

get_role(role_id)

Parameters:

role_id (str)

Return type:

Role

get_user(user_id)

Parameters:

user_id (str)

Return type:

User

list_application_groups(application_id, slice_reference)

Parameters:

• application_id (str)

• slice_reference (SliceReference)

Return type:

Slice[GroupSummary]

list_group_applications(group_id, slice_reference)

Parameters:

• group_id (str)

• slice_reference (SliceReference)

Return type:

Slice[Application]

list_group_roles(group_id, slice_reference)

Parameters:

• group_id (str)

• slice_reference (SliceReference)

Return type:

Slice[Role]

list_group_users(group_id, slice_reference)

Parameters:

• group_id (str)

• slice_reference (SliceReference)

Return type:

Slice[User]

list_permissions()

Return type:

List[PermissionDetail]

list_role_groups(role_id, slice_reference)

Parameters:

• role_id (str)

• slice_reference (SliceReference)

Return type:

Slice[GroupSummary]

list_user_groups(user_id, slice_reference)

Parameters:

• user_id (str)

• slice_reference (SliceReference)

Return type:

Slice[GroupSummary]

regenerate_application_api_key(application_id)

Parameters:

application_id (str)

Return type:

ApiKey

remove_application_from_group(group_id, application_id)

Parameters:

• group_id (str)

• application_id (str)

Return type:

None

remove_role_from_group(group_id, role_id)

Parameters:

• group_id (str)

• role_id (str)

Return type:

None

remove_user_from_group(group_id, user_id)

Parameters:

• group_id (str)

• user_id (str)

Return type:

None

search_applications(search, slice_reference)

Parameters:

• search (ApplicationSearch)

• slice_reference (SliceReference)

Return type:

Slice[Application]

search_groups(search, slice_reference)

Parameters:

• search (GroupSearch)

• slice_reference (SliceReference)

Return type:

Slice[GroupSummary]

search_roles(search, slice_reference)

Parameters:

• search (RoleSearch)

• slice_reference (SliceReference)

Return type:

Slice[Role]

search_users(search, slice_reference)

Parameters:

• search (UserSearch)

• slice_reference (SliceReference)

Return type:

Slice[User]

update_application(application_id, request)

Parameters:

• application_id (str)

• request (UpdateApplicationRequest)

Return type:

Application

update_group(group_id, request)

Parameters:

• group_id (str)

• request (UpdateGroupRequest)

Return type:

Group

class yellowdog_client.account.ApplicationClient

abstractmethod get_application_details()

Return type:

ApplicationDetails

class yellowdog_client.account.ApplicationClientImpl(service_proxy)

Parameters:

service_proxy (ApplicationServiceProxy)

close()

Return type:

None

get_application_details()

Return type:

ApplicationDetails

class yellowdog_client.account.ApplicationServiceProxy(proxy)

Parameters:

proxy (Proxy)

get_application_details()

Return type:

ApplicationDetails

class yellowdog_client.account.KeyringClient

abstractmethod create_keyring(name, description)

Parameters:

• name (str)

• description (str)

Return type:

Keyring

abstractmethod delete_credential(keyring, credential_name)

Parameters:

• keyring (Keyring)

• credential_name (str)

Return type:

Keyring

abstractmethod delete_credential_by_name(keyring_name, credential_name)

Parameters:

• keyring_name (str)

• credential_name (str)

Return type:

Keyring

abstractmethod delete_keyring(keyring)

Parameters:

keyring (Keyring)

Return type:

None

abstractmethod delete_keyring_by_name(keyring_name)

Parameters:

keyring_name (str)

Return type:

None

abstractmethod find_all_keyrings()

Return type:

List[KeyringSummary]

abstractmethod put_credential(keyring, credential)

Parameters:

• keyring (Keyring)

• credential (Credential)

Return type:

Keyring

abstractmethod put_credential_by_name(keyring_name, credential)

Parameters:

• keyring_name (str)

• credential (Credential)

Return type:

Keyring

class yellowdog_client.account.KeyringClientImpl(service_proxy)

Parameters:

service_proxy (KeyringServiceProxy)

close()

create_keyring(name, description)

Parameters:

• name (str)

• description (str)

Return type:

Keyring

delete_credential(keyring, credential_name)

Parameters:

• keyring (Keyring)

• credential_name (str)

Return type:

Keyring

delete_credential_by_name(keyring_name, credential_name)

Parameters:

• keyring_name (str)

• credential_name (str)

Return type:

Keyring

delete_keyring(keyring)

Parameters:

keyring (Keyring)

Return type:

None

delete_keyring_by_name(keyring_name)

Parameters:

keyring_name (str)

Return type:

None

find_all_keyrings()

Return type:

List[KeyringSummary]

put_credential(keyring, credential)

Parameters:

• keyring (Keyring)

• credential (Credential)

Return type:

Keyring

put_credential_by_name(keyring_name, credential)

Parameters:

• keyring_name (str)

• credential (Credential)

Return type:

Keyring

class yellowdog_client.account.KeyringServiceProxy(proxy)

Parameters:

proxy (Proxy)

create_keyring(name, description)

delete_credential(keyring_name, credential_name)

Parameters:

• keyring_name (str)

• credential_name (str)

Return type:

Keyring

delete_keyring(keyring_name)

Parameters:

keyring_name (str)

Return type:

None

find_all_keyrings()

Return type:

List[KeyringSummary]

put_credential(keyring_name, credential)

Parameters:

• keyring_name (str)

• credential (Credential)

Return type:

Keyring