User

class geodesic.account.user.User(**info)

Bases: geodesic.bases._APIObject

The User class to represent user info and control/update profile and permissions. Certain functionality will be restricted to admins.

Parameters

• **info – metadata about a particular user, this can be used to create or update

• profile. (the User's) –

subject

(str) - the unique identifer of the subject

Descriptor: _StringDescr

alias

(str) - the user’s common name

Descriptor: _StringDescr

first_name

(str) - user’s first name

Descriptor: _StringDescr

middle_name

(str) - user’s middle name

Descriptor: _StringDescr

last_name

(str) - user’s last name

Descriptor: _StringDescr

email

(str) - user’s email address

Descriptor: _RegexDescr

avatar

(str) - publically accessible link to the user’s avatar/profile pic

Descriptor: _StringDescr

pronouns

(str) - user’s preferred personal pronouns

Descriptor: _StringDescr

bio

(str) - user’s short bio

Descriptor: _StringDescr

org

(str) - user’s organization

Descriptor: _StringDescr

get_roles()

Gets and returns all of the roles for this user: admin/internal/user. Global roles CANNOT be set through the REST API.

property roles: List[str]

Deprecated in v1.0.0

Gets and returns all of the roles for this user: admin/internal/user. Global roles CANNOT be set through the REST API.

get_permissions()

Gets and returns the user’s permissions as a list of strings.

Returns

the user’s permissions for various services.

Return type

permissions

update_permissions(permissions)

Sets the user’s permissions on the server side.

Parameters

permissions (List[str]) – a list of permission strings. Only certain permissions are valid.

property permissions: List[str]

Deprecated in v1.0.0

Gets and returns the user’s permissions as a list of strings.

Returns

the user’s permissions for various services.

Return type

permissions

property enabled: bool

Checks if this user’s account is currently enabled in the system. Disabled accounts can’t do anything.

Returns

whether or not the user’s account is enabled.

Return type

enabled

create()

Creates this user on the server side. Only available to admins

save()

Updates this user on the server side. Only available to the admins or the current user

delete()

Delete this account and all associations. Only available to admins or the current user.