Blame view

sources/3rdparty/rackspace/php-opencloud/docs/userguide/Identity/Roles.md 1.77 KB
6d9380f96   Cédric Dupont   Update sources OC...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
  # Roles
  
  ## Intro
  
  A role is a personality that a user assumes when performing a specific set of operations. A role includes a set of rights and privileges. A user assuming a role inherits the rights and privileges associated with the role. A token that is issued to a user includes the list of roles the user can assume. When a user calls a service, that service determines how to interpret a user's roles. A role that grants access to a list of operations or resources within one service may grant access to a completely different list when interpreted by a different service.
  
  ## Setup
  
  Role objects are instantiated from the Identity service. For more details, see the [Service](Service.md) docs.
  
  ## Useful object properties/methods
  
  Property|Getter|Setter
  ---|---|---
  id|`getId()`|`setId()`
  name|`getName()`|`setName()`
  description|`getDescription()`|`setDescription()`
  
  ## List roles
  
  This call lists the global roles available within a specified service.
  
  ```php
  $roles = $service->getRoles();
  
  foreach ($roles as $role) {
     // ...
  }
  ```
  
  For more information about how to use iterators, see the [documentation](../Iterators.md).
  
  ## Get role
  
  This call lists detailed information (id, name, description) for a specified role.
  
  ```php
  $roleId = '123abc';
  $role = $service->getRole($roleId);
  ```
  
  ## Add/delete user roles
  
  To add/remove user roles, you must first instantiate a [user](Users.md) object:
  
  ```php
  $roleId = '123abc';
  
  // add role to user
  $user->addRole($roleId);
  
  // remove role from user
  $user->removeRole($roleId);
  ```
  
  ## List user global roles
  
  This call returns a list of global roles associated with a user:
  
  ```php
  $roles = $user->getRoles();
  
  foreach ($roles as $role) {
     // ...
  }
  ```
  
  For more information about how to use iterators, see the [documentation](../Iterators.md).