Page Comparison

class squirro_client.user.UserApiMixin

Mixin class which encapsulates the functionality of the user API service.

All the methods of this class are made available in the SquirroClient class.

Table of Contents

get_user_data

Return data about a specific user, including any custom values.

• user_id – User identifier.
• api_version – The version of the API to use (optional).

A dictionary which contains the user data.

Example:

>>> client.get_user_data('H5Qv-WhgSBGW0WL8xolSCQ')
{u'email': u'test@test.com',
 u'id': u'H5Qv-WhgSBGW0WL8xolSCQ',
 u'tenant': u'test'}

update_user_data

Update data for the given user. Any value can be set and will be returned again when getting the user.

• user_id – User identifier.
• changes – A dictionary containing user data to be updated.
• api_version – API version to use.

A dictionary which contains the updated user data.

Example:

>>> client.update_user_data('H5Qv-WhgSBGW0WL8xolSCQ',
...                         {'name': 'John Smith'})
{u'email': u'test@test.com',
 u'id': u'H5Qv-WhgSBGW0WL8xolSCQ',
 u'name': u'John Smith',
 u'tenant': u'test'}

get_authentication

Retrieves an authentication for a given service.

• user_id – User identifier
• service – Authentication service

A dictionary containing the authentication data.

Example:

>>> client.get_authentication('H5Qv-WhgSBGW0WL8xolSCQ', 'facebook')
{u'access_secret': u'secret',
 u'access_secret_expires': u'2014-01-09T08:40:00',
 u'access_token': u'token',
 u'access_token_expires': u'2014-01-09T08:40:00',
 u'display_name': u'John Smith',
 u'service_user': u'1234567',
 u'state': u'ok'}

new_or_modify_authentication

Create a new authentication or modify an existing authentication for an external service.

• user_id – User identifier.
• service – Authentication service.
• service_user – Service user identifier.
• access_token – Service access token.
• access_secret – Service access secret.
• display_name – Service user display name.
• access_token_expires – Expiry date for service access token.
• access_secret_expires – Expiry date for service access secret.

A dictionary containing the updated authentication data.

Example:

>>> client.new_or_modify_authentication(
...     'H5Qv-WhgSBGW0WL8xolSCQ', 'facebook', '1234567', 'token',
...     'secret', 'John Smith',
...     datetime.datetime(2014, 1, 9, 8, 40),
...     datetime.datetime(2014, 1, 9, 8, 40))
{u'access_secret': u'secret',
 u'access_secret_expires': u'2014-01-09T08:40:00',
 u'access_token': u'token',
 u'access_token_expires': u'2014-01-09T08:40:00',
 u'display_name': u'John Smith',
 u'service_user': u'1234567',
 u'state': u'ok'}

delete_authentication

Delete an authentication.

• user_id – User identifier.
• service – Service name.

Example:

>>> client.delete_authentication('H5Qv-WhgSBGW0WL8xolSCQ',
...                              'facebook')

new_grant

Create a new grant.

• user_id – User identifier.
• type – Token type, either user or service.
• for_client_id – Client id of the service the token is for. Only used when type is service.
• project_permissions – List of permissions granted with this grant.

A dictionary containing the refresh_token and the id of the grant.

Example:

>>> client.new_grant('H5Qv-WhgSBGW0WL8xolSCQ', 'service',
...                  'abdc0183029498f20c38')
{u'id': u'yL0dnd17RNe9Jpn7uAa8Bw',
 u'refresh_token': u'b4c7440364afb80c2...14e2d538b0b773894ea2'}

delete_grant

Delete a grant.

• user_id – User identifier.
• grant_id – Grant identifier.

Example:

>>> client.delete_grant(
...     'H5Qv-WhgSBGW0WL8xolSCQ', 'yL0dnd17RNe9Jpn7uAa8Bw')

get_user_grants

Get all grants for the provided user.

Example:

>>> client.get_user_grants('H5Qv-WhgSBGW0WL8xolSCQ')
{u'grants': [{u'created_at': u'2012-12-21 16:00:01',
              u'valid_to': u'2022-12-21 16:00:01',
              u'id': u'yL0dnd17RNe9Jpn7uAa8Bw', u'type': u'user'}]}

delete_session

Delete a session.

• user_id – User identifier.
• session_id – Session identifier

Example:

>>> client.delete_session('H5Qv-WhgSBGW0WL8xolSCQ',
...                       'yL0dnd17RNe9Jpn7uAa8Bw')

get_users

Returns all users within the logged-in users tenant.

Example:

>>> client.get_users()
{u'users': [
    {
        u'email': u'user01@example.com',
        u'full_name': u'User 1',
        u'id': u'H5Qv-WhgSBGW0WL8xolSCQ',
        u'role': u'user',
        u'role_permissions': [u'user'],
        u'tenant': u'lW8-FnZlQYWBimxFknYitw',
        …
    }
]}

add_user

Add a new user to the current tenant.

• email – Email address of the user.
• password – Password of the user.
• role – role of the user in the tenant. Must be one of: admin, user, demo, reader

delete_user

Delete a user from the system.

Example:

>>> client.delete_user('H5Qv-WhgSBGW0WL8xolSCQ')

get_project_members

Returns all users and groups associated with the given project.

Example:

>>> client.get_project_members('2sic33jZTi-ifflvQAVcfw')
{u'members': [{
   u'email': u'user01@example.com',
   u'full_name': u'User 1',
   u'member_id': u'H5Qv-WhgSBGW0WL8xolSCQ',
   u'member_type': u'user',
   u'server_role': u'user',
   u'project_role': u'reader',
   u'project_id': '2sic33jZTi-ifflvQAVcfw'
   u'permissions': [u'fingerprints.read.*',
                    u'fingerprints.write.create.adhoc',
                    u'items.read.*',
                    u'previews.read.*',
                    u'projects.read.*',
                    u'savedsearches.read.*',
                    u'scores.read.*',
                    u'signals.read.*',
                    u'sources.read.*']},
    …
]}

The permissions list reflects the permissions the given user or group has in this project. The permissions depend on the user’s project role and server role.

add_project_member

Adds a user or group to a project as a member.

• project_id – Project identifier of the project in which to add the member.
• role – Role of the member. Allowed values: reader, member, admin.
• user_id – Identifier of the user to be added (can’t be combined with group_id).
• group_id – Identifier of the group to be added (can’t be combined with user_id).

Example:

>>> client.add_project_member('2sic33jZTi-ifflvQAVcfw', 'member',
                              user_id='H5Qv-WhgSBGW0WL8xolSCQ')
{
   u'email': u'user01@example.com',
   u'full_name': u'User 1',
   u'member_id': u'H5Qv-WhgSBGW0WL8xolSCQ',
   u'member_type': u'user',
   u'server_role': u'user',
   u'project_role': u'member',
   u'project_id': '2sic33jZTi-ifflvQAVcfw'
   u'permissions': [u'fingerprints.*',
                    u'items.*',
                    u'previews.*',
                    u'projects.read.*',
                    u'projects.write.*',
                    u'savedsearches.*',
                    u'scores.*',
                    u'signals.*',
                    u'sources.*']
}

update_project_member

Modifies a project membership.

Right now only the role can be changed, so that argument is required.

• project_id – Project identifier of the project in which to modify the member.
• member_id – Identifier of the user or group to be updated.
• role – New role of the member. Allowed values: reader, member, admin.

Example:

>>> client.update_project_member('2sic33jZTi-ifflvQAVcfw',
...                              'H5Qv-WhgSBGW0WL8xolSCQ',
...                              'admin')
{
   u'email': u'user01@example.com',
   u'full_name': u'User 1',
   u'member_id': u'H5Qv-WhgSBGW0WL8xolSCQ',
   u'member_type': u'admin',
   …
}

delete_project_member

Removes a user or group from a project as a member.

• project_id – Project identifier of the project to remove the member from.
• member_id – Identifier of the user or group to be removed.

Example:

>>> client.delete_project_member('2sic33jZTi-ifflvQAVcfw',
                                 'H5Qv-WhgSBGW0WL8xolSCQ')

get_groups

Returns all groups within the logged-in users tenant.

Example:

>>> client.get_groups()
[{u'id': u'1jo-WmmyRvC8UYtPMIQaoQ',
  u'name': 'Team East',
  u'members': [
      {
          u'email': u'user01@example.com',
          u'full_name': u'User 1',
          u'id': u'H5Qv-WhgSBGW0WL8xolSCQ',
          u'role': u'user',
          u'role_permissions': [u'user'],
          u'tenant': 'lW8-FnZlQYWBimxFknYitw'
      }
  ]
 }
]

create_group

Create a new group.

Example:

>>> client.create_group('Team East')
{
    u'id': u'1jo-WmmyRvC8UYtPMIQaoQ',
    u'name': 'Team East',
    u'members': []
}

get_group

Returns details, including the members, of a group.

Example:

>>> client.get_group('1jo-WmmyRvC8UYtPMIQaoQ')
{
    u'id': u'1jo-WmmyRvC8UYtPMIQaoQ',
    u'name': 'Team East',
    u'members': [
        {
            u'email': u'user01@example.com',
            u'full_name': u'User 1',
            u'id': u'H5Qv-WhgSBGW0WL8xolSCQ',
            u'role': u'user',
            u'role_permissions': [u'user'],
            u'tenant': 'lW8-FnZlQYWBimxFknYitw'
        }
    ]
}

update_group

Modify a group’s attributes.

• group_id – Identifier of the group to modify.
• name – New name of the group.

Example:

>>> client.update_group('1jo-WmmyRvC8UYtPMIQaoQ', 'Team West')
{
    u'id': u'1jo-WmmyRvC8UYtPMIQaoQ',
    u'name': 'Team West',
    u'members': [
        {
            u'email': u'user01@example.com',
            u'full_name': u'User 1',
            u'id': u'H5Qv-WhgSBGW0WL8xolSCQ',
            u'role': u'user',
            u'role_permissions': [u'user'],
            u'tenant': 'lW8-FnZlQYWBimxFknYitw'
        }
    ]
}

delete_group

Delete a group.

Example:

>>> client.delete_group('1jo-WmmyRvC8UYtPMIQaoQ')

add_group_member

Adds a user to the group.

• group_id – Identifier of the group to add the user to.
• user_id – Identifier of the user to add to the group.

Example:

>>> client.add_group_member('1jo-WmmyRvC8UYtPMIQaoQ',
                            'H5Qv-WhgSBGW0WL8xolSCQ')
{
    u'email': u'user01@example.com',
    u'full_name': u'User 1',
    u'id': u'H5Qv-WhgSBGW0WL8xolSCQ',
    u'role': u'user',
    u'role_permissions': [u'user'],
    u'tenant': 'lW8-FnZlQYWBimxFknYitw'
}

delete_group_member

Removes a user from the group.

• group_id – Identifier of the group from which to remove the user.
• user_id – Identifier of the user to remove from the group.

Example: