Authorization and Permissions

Classes related to authorization and permission management.

class pypgx.api.auth.PermissionEntity(name: str, authorization_type, java_permission_entity_class)

Bases: object

Class representing an entity which can receive permissions.

get_name() → str

Get the entity name.

Returns

the entity name

Return type

str

get_type()

Get the authorization type.

This indicates if the entity is a user or a role.

Returns

the authorization type

class pypgx.api.auth.PgxRole(name: str)

Bases: pypgx.api.auth._permission_entity.PermissionEntity

Class representing a role for the purposes of permission management.

get_name() → str

Get the entity name.

Returns

the entity name

Return type

str

get_type()

Get the authorization type.

This indicates if the entity is a user or a role.

Returns

the authorization type

class pypgx.api.auth.PgxUser(name: str)

Bases: pypgx.api.auth._permission_entity.PermissionEntity

Class representing a user for the purposes of permission management.

get_name() → str

Get the entity name.

Returns

the entity name

Return type

str

get_type()

Get the authorization type.

This indicates if the entity is a user or a role.

Returns

the authorization type