swagger_server.controllers.access_control_controller module

swagger_server.controllers.access_control_controller.access_control_roleresourcepermission_delete(role_id, resource_id, permission_id)[source]
# noqa: E501
Parameters:
  • role_id (int) – A unique integer value identifying the role.
  • resource_id (int) – A unique integer value identifying the resource.
  • permission_id (int) – A unique integer value identifying the permission.
Return type:

None
swagger_server.controllers.access_control_controller.domain_create(data=None)[source]
# noqa: E501
Parameters:data (dict | bytes) –
Return type:Domain
swagger_server.controllers.access_control_controller.domain_delete(domain_id)[source]
# noqa: E501
Parameters:domain_id (int) – A unique integer value identifying the domain.
Return type:None
swagger_server.controllers.access_control_controller.domain_list(offset=None, limit=None, parent_id=None, domain_ids=None)[source]
# noqa: E501
Parameters:
  • offset (int) – An optional query parameter specifying the offset in the result set to start from.
  • limit (int) – An optional query parameter to limit the number of results returned.
  • parent_id (int) – An optional query parameter to filter by parent_id
  • domain_ids (List[int]) – An optional list of domain ids
Return type:

List[Domain]
swagger_server.controllers.access_control_controller.domain_read(domain_id)[source]
# noqa: E501
Parameters:domain_id (int) – A unique integer value identifying the domain.
Return type:Domain
swagger_server.controllers.access_control_controller.domain_update(domain_id, data=None)[source]
# noqa: E501
Parameters:
  • domain_id (int) – A unique integer value identifying the domain.
  • data (dict | bytes) –
Return type:

Domain
swagger_server.controllers.access_control_controller.domainrole_create(data=None)[source]
# noqa: E501
Parameters:data (dict | bytes) –
Return type:DomainRole
swagger_server.controllers.access_control_controller.domainrole_delete(domain_id, role_id)[source]
# noqa: E501
Parameters:
  • domain_id (int) – A unique integer value identifying the domain.
  • role_id (int) – A unique integer value identifying the role.
Return type:

None
swagger_server.controllers.access_control_controller.domainrole_list(offset=None, limit=None, domain_id=None, role_id=None)[source]
# noqa: E501
Parameters:
  • offset (int) – An optional query parameter specifying the offset in the result set to start from.
  • limit (int) – An optional query parameter to limit the number of results returned.
  • domain_id (int) – An optional query parameter to filter by domain_id
  • role_id (int) – An optional query parameter to filter by role_id
Return type:

List[DomainRole]
swagger_server.controllers.access_control_controller.domainrole_read(domain_id, role_id)[source]
# noqa: E501
Parameters:
  • domain_id (int) – A unique integer value identifying the domain.
  • role_id (int) – A unique integer value identifying the role.
Return type:

DomainRole
swagger_server.controllers.access_control_controller.domainrole_update(domain_id, role_id, data=None)[source]
# noqa: E501
Parameters:
  • domain_id (int) – A unique integer value identifying the domain.
  • role_id (int) – A unique integer value identifying the role.
  • data (dict | bytes) –
Return type:

DomainRole
swagger_server.controllers.access_control_controller.invitation_create(data=None)[source]
# noqa: E501
Parameters:data (dict | bytes) –
Return type:Invitation
swagger_server.controllers.access_control_controller.invitation_delete(invitation_id)[source]
# noqa: E501
Parameters:invitation_id (dict | bytes) – A UUID value identifying the invitation.
Return type:None
swagger_server.controllers.access_control_controller.invitation_list(offset=None, limit=None, invitor_id=None, invitation_ids=None)[source]
# noqa: E501
Parameters:
  • offset (int) – An optional query parameter specifying the offset in the result set to start from.
  • limit (int) – An optional query parameter to limit the number of results returned.
  • invitor_id (dict | bytes) – Optional filter based on the invitor (the user who created the invitation)
  • invitation_ids (List[str]) – An optional list of invitation ids
Return type:

List[Invitation]
swagger_server.controllers.access_control_controller.invitation_read(invitation_id)[source]
# noqa: E501
Parameters:invitation_id (dict | bytes) – A UUID value identifying the invitation.
Return type:Invitation
swagger_server.controllers.access_control_controller.invitation_redeem(invitation_id, user_id)[source]

Assign all roles assigned to the invitation to the specified user, removing the invitation and related configuration when done. Note: We may have to change the role assignment to an asynchronous task depending on the complexity of the implementation. # noqa: E501

Parameters:
  • invitation_id (dict | bytes) – A UUID value identifying the invitation.
  • user_id (dict | bytes) – A UUID value identifying the user.
Return type:

AllUserRoles
swagger_server.controllers.access_control_controller.invitation_update(invitation_id, data=None)[source]
# noqa: E501
Parameters:
  • invitation_id (dict | bytes) – A UUID value identifying the invitation.
  • data (dict | bytes) –
Return type:

Invitation
swagger_server.controllers.access_control_controller.invitationdomainrole_create(data=None)[source]
# noqa: E501
Parameters:data (dict | bytes) –
Return type:InvitationDomainRole
swagger_server.controllers.access_control_controller.invitationdomainrole_delete(invitation_id, domain_id, role_id)[source]
# noqa: E501
Parameters:
  • invitation_id (dict | bytes) – A UUID value identifying the invitation.
  • domain_id (int) – A unique integer value identifying the domain.
  • role_id (int) – A unique integer value identifying the role.
Return type:

None
swagger_server.controllers.access_control_controller.invitationdomainrole_list(offset=None, limit=None, invitation_id=None, domain_id=None, role_id=None)[source]
# noqa: E501
Parameters:
  • offset (int) – An optional query parameter specifying the offset in the result set to start from.
  • limit (int) – An optional query parameter to limit the number of results returned.
  • invitation_id (dict | bytes) – An optional query parameter to filter by invitation_id
  • domain_id (int) – An optional query parameter to filter by domain_id
  • role_id (int) – An optional query parameter to filter by role_id
Return type:

List[InvitationDomainRole]
swagger_server.controllers.access_control_controller.invitationdomainrole_read(invitation_id, domain_id, role_id)[source]
# noqa: E501
Parameters:
  • invitation_id (dict | bytes) – A UUID value identifying the invitation.
  • domain_id (int) – A unique integer value identifying the domain.
  • role_id (int) – A unique integer value identifying the role.
Return type:

InvitationDomainRole
swagger_server.controllers.access_control_controller.invitationsiterole_create(data=None)[source]
# noqa: E501
Parameters:data (dict | bytes) –
Return type:InvitationSiteRole
swagger_server.controllers.access_control_controller.invitationsiterole_delete(invitation_id, site_id, role_id)[source]
# noqa: E501
Parameters:
  • invitation_id (dict | bytes) – A UUID value identifying the invitation.
  • site_id (int) – A unique integer value identifying the site.
  • role_id (int) – A unique integer value identifying the role.
Return type:

None
swagger_server.controllers.access_control_controller.invitationsiterole_list(offset=None, limit=None, invitation_id=None, site_id=None, role_id=None)[source]
# noqa: E501
Parameters:
  • offset (int) – An optional query parameter specifying the offset in the result set to start from.
  • limit (int) – An optional query parameter to limit the number of results returned.
  • invitation_id (dict | bytes) – An optional query parameter to filter by invitation_id
  • site_id (int) – An optional query parameter to filter by site_id
  • role_id (int) – An optional query parameter to filter by role_id
Return type:

List[InvitationSiteRole]
swagger_server.controllers.access_control_controller.invitationsiterole_read(invitation_id, site_id, role_id)[source]
# noqa: E501
Parameters:
  • invitation_id (dict | bytes) – A UUID value identifying the invitation.
  • site_id (int) – A unique integer value identifying the site.
  • role_id (int) – A unique integer value identifying the role.
Return type:

InvitationSiteRole
swagger_server.controllers.access_control_controller.permission_create(data=None)[source]
# noqa: E501
Parameters:data (dict | bytes) –
Return type:Permission
swagger_server.controllers.access_control_controller.permission_delete(permission_id)[source]
# noqa: E501
Parameters:permission_id (int) – A unique integer value identifying the permission.
Return type:None
swagger_server.controllers.access_control_controller.permission_list(offset=None, limit=None, permission_ids=None)[source]
# noqa: E501
Parameters:
  • offset (int) – An optional query parameter specifying the offset in the result set to start from.
  • limit (int) – An optional query parameter to limit the number of results returned.
  • permission_ids (List[int]) – An optional list of permission ids
Return type:

List[Permission]
swagger_server.controllers.access_control_controller.permission_read(permission_id)[source]
# noqa: E501
Parameters:permission_id (int) – A unique integer value identifying the permission.
Return type:Permission
swagger_server.controllers.access_control_controller.permission_update(permission_id, data=None)[source]
# noqa: E501
Parameters:
  • permission_id (int) – A unique integer value identifying the permission.
  • data (dict | bytes) –
Return type:

Permission
swagger_server.controllers.access_control_controller.resource_create(data=None)[source]
# noqa: E501
Parameters:data (dict | bytes) –
Return type:Resource
swagger_server.controllers.access_control_controller.resource_delete(resource_id)[source]
# noqa: E501
Parameters:resource_id (int) – A unique integer value identifying the resource.
Return type:None
swagger_server.controllers.access_control_controller.resource_list(offset=None, limit=None, prefix=None, resource_ids=None)[source]
# noqa: E501
Parameters:
  • offset (int) – An optional query parameter specifying the offset in the result set to start from.
  • limit (int) – An optional query parameter to limit the number of results returned.
  • prefix (str) – An optional URN prefix filter
  • resource_ids (List[int]) – An optional list of resource ids
Return type:

List[Resource]
swagger_server.controllers.access_control_controller.resource_read(resource_id)[source]
# noqa: E501
Parameters:resource_id (int) – A unique integer value identifying the resource.
Return type:Resource
swagger_server.controllers.access_control_controller.resource_update(resource_id, data=None)[source]
# noqa: E501
Parameters:
  • resource_id (int) – A unique integer value identifying the resource.
  • data (dict | bytes) –
Return type:

Resource
swagger_server.controllers.access_control_controller.role_create(data=None)[source]
# noqa: E501
Parameters:data (dict | bytes) –
Return type:Role
swagger_server.controllers.access_control_controller.role_delete(role_id)[source]
# noqa: E501
Parameters:role_id (int) – A unique integer value identifying the role.
Return type:None
swagger_server.controllers.access_control_controller.role_list(offset=None, limit=None, role_ids=None)[source]
# noqa: E501
Parameters:
  • offset (int) – An optional query parameter specifying the offset in the result set to start from.
  • limit (int) – An optional query parameter to limit the number of results returned.
  • role_ids (List[int]) – An optional list of role ids
Return type:

List[Role]
swagger_server.controllers.access_control_controller.role_read(role_id)[source]
# noqa: E501
Parameters:role_id (int) – A unique integer value identifying the role.
Return type:Role
swagger_server.controllers.access_control_controller.role_update(role_id, data=None)[source]
# noqa: E501
Parameters:
  • role_id (int) – A unique integer value identifying the role.
  • data (dict | bytes) –
Return type:

Role
swagger_server.controllers.access_control_controller.roleresourcepermission_create(data=None)[source]
# noqa: E501
Parameters:data (dict | bytes) –
Return type:RoleResourcePermission
swagger_server.controllers.access_control_controller.roleresourcepermission_list(offset=None, limit=None, role_id=None, resource_id=None, permission_id=None)[source]
# noqa: E501
Parameters:
  • offset (int) – An optional query parameter specifying the offset in the result set to start from.
  • limit (int) – An optional query parameter to limit the number of results returned.
  • role_id (int) – An optional query parameter to filter by role_id
  • resource_id (int) – An optional resource filter
  • permission_id (int) – An optional permission filter
Return type:

List[RoleResourcePermission]
swagger_server.controllers.access_control_controller.roleresourcepermission_read(role_id, resource_id, permission_id)[source]
# noqa: E501
Parameters:
  • role_id (int) – A unique integer value identifying the role.
  • resource_id (int) – A unique integer value identifying the resource.
  • permission_id (int) – A unique integer value identifying the permission.
Return type:

RoleResourcePermission
swagger_server.controllers.access_control_controller.site_create(data=None)[source]
# noqa: E501
Parameters:data (dict | bytes) –
Return type:Site
swagger_server.controllers.access_control_controller.site_delete(site_id)[source]
# noqa: E501
Parameters:site_id (int) – A unique integer value identifying the site.
Return type:None
swagger_server.controllers.access_control_controller.site_list(offset=None, limit=None, site_ids=None, client_id=None)[source]
# noqa: E501
Parameters:
  • offset (int) – An optional query parameter specifying the offset in the result set to start from.
  • limit (int) – An optional query parameter to limit the number of results returned.
  • site_ids (List[int]) – An optional list of site ids
  • client_id (int) – An optional client id to filter on
Return type:

List[Site]
swagger_server.controllers.access_control_controller.site_read(site_id)[source]
# noqa: E501
Parameters:site_id (int) – A unique integer value identifying the site.
Return type:Site
swagger_server.controllers.access_control_controller.site_update(site_id, data=None)[source]
# noqa: E501
Parameters:
  • site_id (int) – A unique integer value identifying the site.
  • data (dict | bytes) –
Return type:

Site
swagger_server.controllers.access_control_controller.siterole_create(data=None)[source]
# noqa: E501
Parameters:data (dict | bytes) –
Return type:SiteRole
swagger_server.controllers.access_control_controller.siterole_delete(site_id, role_id)[source]
# noqa: E501
Parameters:
  • site_id (int) – A unique integer value identifying the site.
  • role_id (int) – A unique integer value identifying the role.
Return type:

None
swagger_server.controllers.access_control_controller.siterole_list(offset=None, limit=None, site_id=None, role_id=None)[source]
# noqa: E501
Parameters:
  • offset (int) – An optional query parameter specifying the offset in the result set to start from.
  • limit (int) – An optional query parameter to limit the number of results returned.
  • site_id (int) – An optional query parameter to filter by site_id
  • role_id (int) – An optional query parameter to filter by role_id
Return type:

List[SiteRole]
swagger_server.controllers.access_control_controller.siterole_read(site_id, role_id)[source]
# noqa: E501
Parameters:
  • site_id (int) – A unique integer value identifying the site.
  • role_id (int) – A unique integer value identifying the role.
Return type:

SiteRole
swagger_server.controllers.access_control_controller.siterole_update(site_id, role_id, data=None)[source]
# noqa: E501
Parameters:
  • site_id (int) – A unique integer value identifying the site.
  • role_id (int) – A unique integer value identifying the role.
  • data (dict | bytes) –
Return type:

SiteRole
swagger_server.controllers.access_control_controller.userdomainrole_create(data=None)[source]
# noqa: E501
Parameters:data (dict | bytes) –
Return type:UserDomainRole
swagger_server.controllers.access_control_controller.userdomainrole_delete(user_id, domain_id, role_id)[source]
# noqa: E501
Parameters:
  • user_id (dict | bytes) – A UUID value identifying the user.
  • domain_id (int) – A unique integer value identifying the domain.
  • role_id (int) – A unique integer value identifying the role.
Return type:

None
swagger_server.controllers.access_control_controller.userdomainrole_list(offset=None, limit=None, user_id=None, domain_id=None, role_id=None)[source]
# noqa: E501
Parameters:
  • offset (int) – An optional query parameter specifying the offset in the result set to start from.
  • limit (int) – An optional query parameter to limit the number of results returned.
  • user_id (dict | bytes) – An optional query parameter to filter by user_id
  • domain_id (int) – An optional query parameter to filter by domain_id
  • role_id (int) – An optional query parameter to filter by role_id
Return type:

List[UserDomainRole]
swagger_server.controllers.access_control_controller.userdomainrole_read(user_id, domain_id, role_id)[source]
# noqa: E501
Parameters:
  • user_id (dict | bytes) – A UUID value identifying the user.
  • domain_id (int) – A unique integer value identifying the domain.
  • role_id (int) – A unique integer value identifying the role.
Return type:

UserDomainRole
swagger_server.controllers.access_control_controller.usersiterole_create(data=None)[source]
# noqa: E501
Parameters:data (dict | bytes) –
Return type:UserSiteRole
swagger_server.controllers.access_control_controller.usersiterole_delete(user_id, site_id, role_id)[source]
# noqa: E501
Parameters:
  • user_id (dict | bytes) – A UUID value identifying the user.
  • site_id (int) – A unique integer value identifying the site.
  • role_id (int) – A unique integer value identifying the role.
Return type:

None
swagger_server.controllers.access_control_controller.usersiterole_list(offset=None, limit=None, user_id=None, site_id=None, role_id=None)[source]
# noqa: E501
Parameters:
  • offset (int) – An optional query parameter specifying the offset in the result set to start from.
  • limit (int) – An optional query parameter to limit the number of results returned.
  • user_id (dict | bytes) – An optional query parameter to filter by user_id
  • site_id (int) – An optional query parameter to filter by site_id
  • role_id (int) – An optional query parameter to filter by role_id
Return type:

List[UserSiteRole]
swagger_server.controllers.access_control_controller.usersiterole_read(user_id, site_id, role_id)[source]
# noqa: E501
Parameters:
  • user_id (dict | bytes) – A UUID value identifying the user.
  • site_id (int) – A unique integer value identifying the site.
  • role_id (int) – A unique integer value identifying the role.
Return type:

UserSiteRole