Toloka documentation

UserRestriction

toloka.client.user_restriction.UserRestriction | Source code

UserRestriction(
    self,
    *,
    user_id: Optional[str] = None,
    private_comment: Optional[str] = None,
    will_expire: Optional[datetime] = None,
    id: Optional[str] = None,
    created: Optional[datetime] = None
)

Allows you to control the performer's access to your projects and pools

You can close user access to one or more projects. This allows you to control which users will perform tasks. For example, you can select users with a skill value below N and block them from accessing tasks. You can also unlock access.

Parameters Description

Parameters Type Description
user_id Optional[str]

Which performer is denied access.

private_comment Optional[str]

A comment for you why access to this performer was restricted.

will_expire Optional[datetime]

When access is restored. If you do not set the parameter, then the access restriction is permanent.

id Optional[str]

The identifier of a specific fact of access restriction. Read only.

created Optional[datetime]

Date and time when the fact of access restriction was created. Read only.

Examples:

How you can lock access for one user on one project.

new_restrict = toloka_client.set_user_restriction(
    ProjectUserRestriction(
        user_id='1',
        private_comment='I dont like you',
        project_id='5'
    )
)

And how you can unlock it.

toloka_client.delete_user_restriction(new_restrict.id)