Skip to content

Commit 8518ec6

Browse files
committed
Bump v3 API docs version release-candidate
1 parent 2c326e2 commit 8518ec6

File tree

1 file changed

+20
-11
lines changed

1 file changed

+20
-11
lines changed

version/release-candidate/index.html

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17341,7 +17341,7 @@ <h3 id="create-a-role">Create a role</h3>
1734117341

1734217342
<p>For a user to be assigned a space role, the user must already have an organization role in the parent organization.</p>
1734317343

17344-
<p>If the associated user is valid but does not exist in Cloud Controller&rsquo;s database, a user resource will be created automatically.</p>
17344+
<p>If the associated user does not exist in Cloud Controller&rsquo;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>
1734517345

1734617346
<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.
1734717347
The origin must be different from <code class="prettyprint">uaa</code> in this case.</p>
@@ -32495,11 +32495,19 @@ <h4 id="permitted-roles">Permitted roles</h4>
3249532495
</tbody></table>
3249632496
<h2 id="users">Users</h2>
3249732497

32498-
<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 &ldquo;shadow&rdquo; a corresponding user or
32504+
client in UAA. The Cloud Controller user resource&rsquo;s guid should match either a
32505+
UAA user or a UAA client id. However, Cloud Controller does not enforce that
32506+
a user&rsquo;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
3250332511
apps, delete apps).</p>
3250432512
<h3 id="the-user-object">The user object</h3>
3250532513
<div class="highlight"><pre class="highlight plaintext"><code>Example User object
@@ -32532,7 +32540,7 @@ <h3 id="the-user-object">The user object</h3>
3253232540
<tr>
3253332541
<td><strong>guid</strong></td>
3253432542
<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>
3253632544
</tr>
3253732545
<tr>
3253832546
<td><strong>created_at</strong></td>
@@ -32580,9 +32588,10 @@ <h3 id="create-a-user">Create a user</h3>
3258032588
<p>Creating a user requires one value, a GUID. This creates a user in the Cloud
3258132589
Controller database.</p>
3258232590

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>
3258632595

3258732596
<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.
3258832597
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>.
@@ -32665,7 +32674,7 @@ <h4 id="required-parameters">Required parameters</h4>
3266532674
<tr>
3266632675
<td><strong>guid</strong></td>
3266732676
<td><em>string</em></td>
32668-
<td>Unique identifier for the user. For UAA users this will match the user ID of an existing UAA user&rsquo;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>
3266932678
</tr>
3267032679
<tr>
3267132680
<td><strong>username</strong></td>

0 commit comments

Comments
 (0)