You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: version/release-candidate/index.html
+20-11Lines changed: 20 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -17341,7 +17341,7 @@ <h3 id="create-a-role">Create a role</h3>
17341
17341
17342
17342
<p>For a user to be assigned a space role, the user must already have an organization role in the parent organization.</p>
17343
17343
17344
-
<p>If the associated user is valid but does not exist in Cloud Controller’s database, a user resource will be created automatically.</p>
17344
+
<p>If the associated user does not exist in Cloud Controller’s database, a user resource will be created automatically. This user may correspond to a UAA user or client. See the <a href="#users">user resource</a> for more details.</p>
17345
17345
17346
17346
<p>If CAPI property <code class="prettyprint">cc.allow_user_creation_by_org_manager</code> is enabled, the organization role is being created by username + origin and the user does not exist in UAA yet, the user will be created.
17347
17347
The origin must be different from <code class="prettyprint">uaa</code> in this case.</p>
<p>Every Cloud Foundry action (pushing an application, creating a space) requires a
32499
-
user. Each Cloud Foundry installation has one pre-installed user, admin, which
32500
-
can create subsequent users. Users can be assigned roles which give them
32501
-
privileges to perform actions. For example, the Space Developer role grants a
32502
-
user permission to manage apps and services in a space (to push apps, scale
32498
+
<p>The user resource is used to manage access to organizations, spaces, and other
32499
+
resources within Cloud Foundry. Cloud Controller is not the ultimate authority
32500
+
on the users in the Cloud Foundry system; UAA and its configured identity
32501
+
providers determine which users are able to sign in to Cloud Foundry.</p>
32502
+
32503
+
<p>To be functional, Cloud Controller users must “shadow” a corresponding user or
32504
+
client in UAA. The Cloud Controller user resource’s guid should match either a
32505
+
UAA user or a UAA client id. However, Cloud Controller does not enforce that
32506
+
a user’s guid is a valid UAA user or client id.</p>
32507
+
32508
+
<p>Users can be assigned roles, which give them privileges to perform actions
32509
+
within a given context. For example, the Space Developer role grants a user
32510
+
permission to manage apps and services in a space (e.g. to push apps, scale
32503
32511
apps, delete apps).</p>
32504
32512
<h3 id="the-user-object">The user object</h3>
32505
32513
<div class="highlight"><pre class="highlight plaintext"><code>Example User object
@@ -32532,7 +32540,7 @@ <h3 id="the-user-object">The user object</h3>
32532
32540
<tr>
32533
32541
<td><strong>guid</strong></td>
32534
32542
<td><em>uuid</em></td>
32535
-
<td>Unique identifier for the user</td>
32543
+
<td>Unique identifier for the user, matching either a UAA user id or client id</td>
32536
32544
</tr>
32537
32545
<tr>
32538
32546
<td><strong>created_at</strong></td>
@@ -32580,9 +32588,10 @@ <h3 id="create-a-user">Create a user</h3>
32580
32588
<p>Creating a user requires one value, a GUID. This creates a user in the Cloud
32581
32589
Controller database.</p>
32582
32590
32583
-
<p>Generally, the GUID should match the GUID of an already-created user in the
32584
-
UAA database, though this is not required.
32585
-
Creating a user by guid is only permitted by admins.</p>
32591
+
<p>Generally, the GUID should match the ID of an already-created user in the UAA
32592
+
database, though this is not required. The GUID can also be a UAA client ID, to
32593
+
support the UAA <code class="prettyprint">client_credentials</code> grant type. Creating a user by guid is
32594
+
only permitted by admins.</p>
32586
32595
32587
32596
<p>If CAPI property <code class="prettyprint">cc.allow_user_creation_by_org_manager</code> is enabled, a UAA user will be automatically created if it does not exist yet.
32588
32597
The UAA user will be only created when <code class="prettyprint">username</code> and <code class="prettyprint">origin</code> have been provided instead of a guid. Additionally <code class="prettyprint">origin</code> must be different from <code class="prettyprint">uaa</code>.
<td>Unique identifier for the user. For UAA users this will match the user ID of an existing UAA user’s GUID; in the case of UAA clients, this will match the UAA client ID</td>
32677
+
<td>Unique identifier for the user. For UAA users this will match the UAA user ID; in the case of UAA clients, this will match the UAA client ID</td>
0 commit comments