User Metrics Types

class indico.types.user_metrics.AppRoles(**kwargs)

Info about roles. Name and how many users have this role.

role

A role name

  • Type:
    str

count

Count of how many users have said role.

  • Type:
    int

class indico.types.user_metrics.UserDatasets(**kwargs)

Dataset Id and roles assigned to user in that dataset.

dataset_id

The id of a particular dataset

  • Type:
    int

role

A dataset assigned to said dataset.

  • Type:
    str

class indico.types.user_metrics.UserSummaryCounts(**kwargs)

Summary of user counts

enabled

How many user accounts are enabled.

  • Type:
    int

disabled

How many user accounts are disabled.

  • Type:
    int

class indico.types.user_metrics.UserSnapshot(**kwargs)

Individual information about a user and their dataset access

id

The user’s id.

  • Type:
    int

name

The user’s name.

  • Type:
    str

email

The user’s email.

  • Type:
    str

created_at

Time of creation.

  • Type:
    str

enabled

True if user account is enabled.

  • Type:
    bool

roles

List of roles assigned to this user.

  • Type:
    List[str]

datasets

List of datasets this user can access.

class indico.types.user_metrics.UserSummary(**kwargs)

Summary data on users and app roles

users

Counts of enabled/disabled users.

  • Type:
    UserSummarycounts

app_roles

List of all available user roles.

class indico.types.user_metrics.DatasetRole(**kwargs)

Dataset role information

dataset_id

Id of a particular dataset.

  • Type:
    int

role

Role name which has access to this dataset.

  • Type:
    str

class indico.types.user_metrics.UserChangelog(**kwargs)

Log entry of a change made to a user’s permission

id

Id of the log entry

  • Type:
    str

date

Time of long entry.

  • Type:
    datetime

user_id

Id of the user whose attributes were changed.

  • Type:
    int

user_email

Email of the user whose attributes were changed.

  • Type:
    str

updated_by

Id of the account which made the change.

  • Type:
    id

updater_email

Email of the account which made the change.

  • Type:
    str

previously_enabled

True if this account was enabled prior to change.

  • Type:
    bool

enabled

True if account is enabled after the change.

  • Type:
    bool

previous_roles

Roles assigned prior to the change.

  • Type:
    List[str]

roles

Roles assigned after the change.

  • Type:
    List[str]

previous_datasets

List of dataset/role mappings prior to the change.

datasets

List of dataset/role mappings after the change.

changes_made

A list of changed made.

  • Type:
    List[str]

class indico.types.user_metrics.UserChangelogReport(**kwargs)

Job id of a request for a changelog report file for download

job_id

The job id. Use for fetching JobStatus.

  • Type:
    str