Roles
extends CloudApiBase
in
implements
CloudApiInterface
Class Roles
Table of Contents
| $client | ClientInterface | |
|---|---|---|
| getAll() | Show all roles in an organization. | RolesResponse |
| get() | Return details about a specific role. | RoleResponse |
| create() | Create a new role. | OperationResponse |
| update() | Update the permissions associated with a role. | OperationResponse |
| delete() | Delete a role. | OperationResponse |
| __construct() | Client constructor. | mixed |
Properties
$client
protected
ClientInterface
$client
Methods
getAll()
Show all roles in an organization.
public
getAll(
$organizationUuid :
string
)
: RolesResponse
Parameters
- $organizationUuid : string
Return values
RolesResponseget()
Return details about a specific role.
public
get(
$roleUuid :
string
)
: RoleResponse
Parameters
- $roleUuid : string
Return values
RoleResponsecreate()
Create a new role.
public
create(
$organizationUuid :
string
, $name :
string
, $permissions :
array
[, $description :
null|string
= null ]
)
: OperationResponse
Parameters
- $organizationUuid : string
- $name : string
- $permissions : array
- $description : null|string = null
Return values
OperationResponseupdate()
Update the permissions associated with a role.
public
update(
$roleUuid :
string
, $permissions :
array
)
: OperationResponse
Parameters
- $roleUuid : string
- $permissions : array
Return values
OperationResponsedelete()
Delete a role.
public
delete(
$roleUuid :
string
)
: OperationResponse
Parameters
- $roleUuid : string
Return values
OperationResponse__construct()
Client constructor.
public
__construct(
$client :
ClientInterface
)
: mixed
Parameters
- $client : ClientInterface