Skip to content

Commit

Permalink
Merge pull request #4966 from mpmadhavig/user-response
Browse files Browse the repository at this point in the history
Add groups param to users endpoint results
  • Loading branch information
himeshsiriwardana authored Jan 20, 2025
2 parents 6eb26c1 + 797a430 commit 792cac1
Show file tree
Hide file tree
Showing 2 changed files with 72 additions and 2 deletions.
72 changes: 71 additions & 1 deletion en/identity-server/5.10.0/docs/develop/restapis/scim2.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1178,6 +1178,76 @@ definitions:
- type: "default"
value: "Internal/everyone"

UsersResponseObject:
type: object
required:
- meta
properties:
meta:
type: object
properties:
created:
type: string
example: "2018-08-17T10:34:29Z"
location:
type: string
example: "https://localhost:9443/scim2/Users/008bba85-451d-414b-87de-c03b5a1f4217"
lastModified:
type: string
example: "2018-08-17T10:34:29Z"
resourceType:
type: string
example: User
schemas:
type: object
example:
- urn:ietf:params:scim:schemas:core:2.0:User
- urn:ietf:params:scim:schemas:extension:enterprise:2.0:User
username:
type: string
example: "PRIMARY/kim"
id:
type: string
example: "008bba85-451d-414b-87de-c03b5a1f4217"
name:
type: object
properties:
givenName:
type: string
example: "Kim"
familyName:
type: string
example: "Berry"
emails:
type: array
items:
type: object
example:
- type: "home"
value: "[email protected]"
primary: true
- type: "work"
value: "[email protected]"
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:
type: object
properties:
employeeNumber:
type: string
example: "1234A"
manager:
type: object
properties:
value:
type: string
example: "Taylor"
groups:
type: array
items:
type: object
example:
type: "admin"
value: "98ad283c-06e3-4bbd-8d05-a97ec76278a8"
$ref : "https://localhost:9443/scim2/Groups/98ad283c-06e3-4bbd-8d05-a97ec76278a8"
#-----------------------------------------------------
# The User Update Object
#-----------------------------------------------------
Expand Down Expand Up @@ -1656,7 +1726,7 @@ definitions:
Resources:
type: array
items:
$ref: "#/definitions/UserResponseObject"
$ref: "#/definitions/UsersResponseObject"

#-----------------------------------------------------
# Search Request Object- User
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -439,7 +439,7 @@ supported across multiple user stores.
<strong>Response</strong>
</div>
<div class="codeContent panelContent pdl">
<div class="sourceCode" id="cb3" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Confluence" data-theme="Confluence" style="brush: java; gutter: false; theme: Confluence"><pre class="sourceCode java"><code class="sourceCode java"><a class="sourceLine" id="cb3-1" title="1">{<span class="st">&quot;totalResults&quot;</span>:<span class="dv">1</span>,<span class="st">&quot;startIndex&quot;</span>:<span class="dv">1</span>,<span class="st">&quot;itemsPerPage&quot;</span>:<span class="dv">1</span>,<span class="st">&quot;schemas&quot;</span>:[<span class="st">&quot;urn:ietf:params:scim:api:messages:2.0:ListResponse&quot;</span>],<span class="st">&quot;Resources&quot;</span>:[{<span class="st">&quot;emails&quot;</span>:[{<span class="st">&quot;type&quot;</span>:<span class="st">&quot;work&quot;</span>,<span class="st">&quot;value&quot;</span>:<span class="st">&quot;[email protected]&quot;</span>},{<span class="st">&quot;type&quot;</span>:<span class="st">&quot;home&quot;</span>,<span class="st">&quot;value&quot;</span>:<span class="st">&quot;[email protected]&quot;</span>}],<span class="st">&quot;meta&quot;</span>:{<span class="st">&quot;created&quot;</span>:<span class="st">&quot;2018-08-15T14:55:23Z&quot;</span>,<span class="st">&quot;location&quot;</span>:<span class="st">&quot;https://localhost:9443/scim2/Users/c8c821ba-1200-495e-a775-79b260e717bd&quot;</span>,<span class="st">&quot;lastModified&quot;</span>:<span class="st">&quot;2018-08-15T14:55:23Z&quot;</span>,<span class="st">&quot;resourceType&quot;</span>:<span class="st">&quot;User&quot;</span>},<span class="st">&quot;roles&quot;</span>:[{<span class="st">&quot;type&quot;</span>:<span class="st">&quot;default&quot;</span>,<span class="st">&quot;value&quot;</span>:<span class="st">&quot;Internal/everyone&quot;</span>}],<span class="st">&quot;name&quot;</span>:{<span class="st">&quot;givenName&quot;</span>:<span class="st">&quot;kim&quot;</span>,<span class="st">&quot;familyName&quot;</span>:<span class="st">&quot;jackson&quot;</span>},<span class="st">&quot;id&quot;</span>:<span class="st">&quot;c8c821ba-1200-495e-a775-79b260e717bd&quot;</span>,<span class="st">&quot;userName&quot;</span>:<span class="st">&quot;kim&quot;</span>}]}</a></code></pre></div>
<div class="sourceCode" id="cb3" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Confluence" data-theme="Confluence" style="brush: java; gutter: false; theme: Confluence"><pre class="sourceCode java"><code class="sourceCode java"><a class="sourceLine" id="cb3-1" title="1">{<span class="st">&quot;totalResults&quot;</span>:<span class="dv">1</span>,<span class="st">&quot;startIndex&quot;</span>:<span class="dv">1</span>,<span class="st">&quot;itemsPerPage&quot;</span>:<span class="dv">1</span>,<span class="st">&quot;schemas&quot;</span>:[<span class="st">&quot;urn:ietf:params:scim:api:messages:2.0:ListResponse&quot;</span>],<span class="st">&quot;Resources&quot;</span>:[{<span class="st">&quot;emails&quot;</span>:[{<span class="st">&quot;type&quot;</span>:<span class="st">&quot;work&quot;</span>,<span class="st">&quot;value&quot;</span>:<span class="st">&quot;[email protected]&quot;</span>},{<span class="st">&quot;type&quot;</span>:<span class="st">&quot;home&quot;</span>,<span class="st">&quot;value&quot;</span>:<span class="st">&quot;[email protected]&quot;</span>}],<span class="st">&quot;meta&quot;</span>:{<span class="st">&quot;created&quot;</span>:<span class="st">&quot;2018-08-15T14:55:23Z&quot;</span>,<span class="st">&quot;location&quot;</span>:<span class="st">&quot;https://localhost:9443/scim2/Users/c8c821ba-1200-495e-a775-79b260e717bd&quot;</span>,<span class="st">&quot;lastModified&quot;</span>:<span class="st">&quot;2018-08-15T14:55:23Z&quot;</span>,<span class="st">&quot;resourceType&quot;</span>:<span class="st">&quot;User&quot;</span>},<span class="st">&quot;groups&quot;</span>:[{<span class="st">&quot;display&quot;</span>:<span class="st">&quot;admin&quot;</span>,<span class="st">&quot;value&quot;</span>:<span class="st">&quot;74f4be74-36bc-4bec-8689-d03c36e4a106&quot;</span>,<span class="st">&quot;$ref&quot;</span>:<span class="st">&quot;https://localhost:9443/scim2/Groups/74f4be74-36bc-4bec-8689-d03c36e4a106&quot;</span>}],<span class="st">&quot;name&quot;</span>:{<span class="st">&quot;givenName&quot;</span>:<span class="st">&quot;kim&quot;</span>,<span class="st">&quot;familyName&quot;</span>:<span class="st">&quot;jackson&quot;</span>},<span class="st">&quot;id&quot;</span>:<span class="st">&quot;c8c821ba-1200-495e-a775-79b260e717bd&quot;</span>,<span class="st">&quot;userName&quot;</span>:<span class="st">&quot;kim&quot;</span>}]}</a></code></pre></div>
</div>
</div>
</div></td>
Expand Down

0 comments on commit 792cac1

Please sign in to comment.