role#

async idem_vra.exec.vra.rbac.role.create_using_post1(hub, ctx, name, permissions, **kwargs)[source]#

Create a role Performs POST /rbac-service/api/roles

Parameters:

  • name (string) – (required in body) Name of the role.

  • permissions (array) – (required in body) List of permissions that the role has.

  • apiVersion (string) – (optional in query)

  • description (string) – (optional in body) A human-friendly description.

  • hidden (boolean) – (optional in body) Specifies whether the role should be hidden (true) in the UI or not (false). The flag is used mainly for development purposes.

  • id (string) – (optional in body)

  • orgId (string) – (optional in body) The id of the org this role belongs to

  • projectScope (boolean) – (optional in body) Specifies whether the role is organization level role or it is project level.

async idem_vra.exec.vra.rbac.role.delete_role_using_delete(hub, ctx, p_id, **kwargs)[source]#

Delete a role by id Performs DELETE /rbac-service/api/roles/{id}

Parameters:

  • p_id (string) – (required in path) id

  • apiVersion (string) – (optional in query)

async idem_vra.exec.vra.rbac.role.get_all_roles_using_get(hub, ctx, **kwargs)[source]#

Get all roles Performs GET /rbac-service/api/roles

Parameters:

  • apiVersion (string) – (optional in query)

  • excludeOrganizationScoped (boolean) – (optional in query) Exclude Organization scoped roles. When the flag is true, it will not include the organization scoped roles.

  • excludeProjectScoped (boolean) – (optional in query) Exclude Project scoped roles. When the flag is true, it will not include the project scoped roles.

async idem_vra.exec.vra.rbac.role.get_role_using_get(hub, ctx, p_id, **kwargs)[source]#

Retrieve a role by id Performs GET /rbac-service/api/roles/{id}

Parameters:

  • p_id (string) – (required in path) id

  • apiVersion (string) – (optional in query)

async idem_vra.exec.vra.rbac.role.update_using_put(hub, ctx, p_id, name, permissions, **kwargs)[source]#

Update a role Performs PUT /rbac-service/api/roles/{id}

Parameters:

  • p_id (string) – (required in path) id

  • name (string) – (required in body) Name of the role.

  • permissions (array) – (required in body) List of permissions that the role has.

  • apiVersion (string) – (optional in query)

  • description (string) – (optional in body) A human-friendly description.

  • hidden (boolean) – (optional in body) Specifies whether the role should be hidden (true) in the UI or not (false). The flag is used mainly for development purposes.

  • id (string) – (optional in body)

  • orgId (string) – (optional in body) The id of the org this role belongs to

  • projectScope (boolean) – (optional in body) Specifies whether the role is organization level role or it is project level.