Returns all User resources.
GEThttp://localhost:8080/identityiq/scim/v2/Users
This endpoint returns all User resources. There are attributes marked as 'returned only by request', such as roles, which must be provided as part of the attributes query parameter in order to be included in the response.
Request
Query Parameters
Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported.
Allows sorting the results by a resource's attributes.
Determines what order to sort results in.
ascending
Determines the starting index of the result set.
1
Specifies the number of results per page.
1000
A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.
A comma-separated list of attributes to exclude from the response. Some attributes cannot be excluded.
Responses
- 200
Returns all SCIM User resources.
- application/json
- application/scim+json
- Schema
- Example (auto)
Schema
Number of User resources returned
18
The starting index of the resource set list. Can be specified with startIndex query parameter.
1
SCIM Schema used for response.
["urn:ietf:params:scim:api:messages:2.0:ListResponse"]
Resources undefined[]
{
"totalResults": 18,
"startIndex": 1,
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"Resources": [
{
"id": "c0b4568a4fe7458c434ee77d1fbt156b",
"userName": "Mock.User",
"name": {
"formatted": "Ms. Barbara J Jensen, III",
"familyName": "Jensen",
"givenName": "Barbara"
},
"displayName": "Barbara Jensen",
"userType": "employee",
"active": true,
"emails": [
{
"type": "work",
"value": "Barbara.Jensen@example.com",
"primary": true
}
],
"urn:ietf:params:scim:schemas:sailpoint:1.0:User": {
"accounts": [
{
"displayName": "Bob.Smith",
"value": "c0a7778b7ef71e79817ee74e6a1f0444",
"$ref": "http://localhost:8080/iiq/scim/v2/Accounts/c0a7778b7ef71e79817ee74e6a1f0444"
}
],
"entitlements": [
{
"value": "groupmbr",
"display": "HelpDesk",
"type": "Permission",
"application": "ADMockApp",
"accountName": "CN=Barbara Jensen,OU=Taipei,OU=Asia-Pacific,DC=example,DC=com",
"$ref": "http://localhost:8080/iiq/scim/v2/Entitlements/c0a7777a7f74744d817e74fc12362c67"
}
],
"roles": [
{
"value": "detectedRoles",
"display": "User - IT",
"type": "it",
"acquired": "Assigned",
"application": "Active_Directory",
"accountName": "CN=Barbara Jensen,OU=Taipei,OU=Asia-Pacific,DC=example,DC=com",
"$ref": "http://localhost:8080/iiq/scim/v2/Roles/c0a7777a7f74744d817e74fc12362c67"
}
],
"capabilities": [
"SystemAdministrator"
],
"riskScore": 125,
"isManager": false,
"administrator": {
"displayName": "Bob Smith",
"value": "c0a7777a7f74744d817e74fc12362c67O",
"$ref": "http://localhost:8080/iiq/scim/v2/Users/c0a7777a7f74744d817e74fc12362c67"
},
"softwareVersion": "7.3",
"empId": "1b2a3c",
"dn": "cn=Bob Smith,ou=services",
"region": "Americas",
"regionOwner": {
"displayName": "Joe Smith",
"value": "c0b4568a4fe7458c434ee77d1fbt156b",
"$ref": "http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b"
},
"location": "Singapore",
"locationOwner": {
"displayName": "Bob Smith",
"value": "c0a7778b7ef71e79817ee74e6a1f0444",
"$ref": "http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444"
},
"Department": "Regional Operations",
"costcenter": [
"CC01",
"DD02"
],
"jobtitle": "Internal Audit Manager",
"lastRefresh": "2024-07-29T15:51:28.071Z"
},
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"manager": {
"displayName": "Bob Smith",
"value": "c7a7347a7fe71e69077ee75f5d1f1237",
"$ref": "http://localhost:8080/iiq/scim/v2/Users/c7a7347a7fe71e69077ee75f5d1f1237"
}
},
"meta": {
"created": "2022-02-11T01:34:04.074-05:00",
"location": "http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b",
"lastModified": "2022-02-11T01:08:45.866-05:00",
"version": "W\"1644561244074\"",
"resourceType": "User"
},
"schemas": [
"urn:ietf:params:scim:schemas:sailpoint:1.0:User",
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
]
}
]
}
- Schema
- Example (auto)
Schema
Number of User resources returned.
1500,
The starting index of the resource set list. Can be specified with startIndex query parameter.
1
SCIM Schema used for response.
["urn:ietf:params:scim:api:messages:2.0:ListResponse"]
Resources undefined[]
{
"totalResults": "1500,",
"startIndex": 1,
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"Resources": [
{
"id": "c0b4568a4fe7458c434ee77d1fbt156b",
"userName": "Mock.User",
"name": {
"formatted": "Ms. Barbara J Jensen, III",
"familyName": "Jensen",
"givenName": "Barbara"
},
"displayName": "Barbara Jensen",
"userType": "employee",
"active": true,
"emails": [
{
"type": "work",
"value": "Barbara.Jensen@example.com",
"primary": "true"
}
],
"urn:ietf:params:scim:schemas:sailpoint:1.0:User": {
"accounts": [
{
"displayName": "Bob.Smith",
"value": "c0a7778b7ef71e79817ee74e6a1f0444",
"$ref": "http://localhost:8080/iiq/scim/v2/Accounts/c0a7778b7ef71e79817ee74e6a1f0444"
}
],
"entitlements": [
{
"value": "groupmbr",
"display": "HelpDesk",
"type": "Permission",
"application": "ADMockApp",
"accountName": "CN=Barbara Jensen,OU=Taipei,OU=Asia-Pacific,DC=example,DC=com",
"$ref": "http://localhost:8080/iiq/scim/v2/Entitlements/c0a7777a7f74744d817e74fc12362c67"
}
],
"roles": [
{
"value": "detectedRoles",
"display": "User - IT",
"type": "it",
"acquired": "Assigned",
"application": "Active_Directory",
"accountName": "CN=Barbara Jensen,OU=Taipei,OU=Asia-Pacific,DC=example,DC=com",
"$ref": "http://localhost:8080/iiq/scim/v2/Roles/c0a7777a7f74744d817e74fc12362c67"
}
],
"capabilities": "[\"SystemAdministrator\"]",
"riskScore": 125,
"isManager": false,
"administrator": {
"displayName": "Bob Smith",
"value": "c0a7777a7f74744d817e74fc12362c67O",
"$ref": "http://localhost:8080/iiq/scim/v2/Users/c0a7777a7f74744d817e74fc12362c67"
},
"softwareVersion": "7.3",
"empId": "1b2a3c",
"dn": "cn=Bob Smith,ou=services",
"region": "Americas",
"regionOwner": {
"displayName": "Joe Smith",
"value": "c0b4568a4fe7458c434ee77d1fbt156b",
"$ref": "http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b"
},
"location": "Singapore",
"locationOwner": {
"displayName": "Bob Smith",
"value": "c0a7778b7ef71e79817ee74e6a1f0444",
"$ref": "http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444"
},
"Department": "Regional Operations",
"costcenter": [
"CC01",
"DD02"
],
"jobtitle": "Internal Audit Manager",
"lastRefresh": "2024-07-29T15:51:28.071Z"
},
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"manager": {
"displayName": "Bob Smith",
"value": "c7a7347a7fe71e69077ee75f5d1f1237",
"$ref": "http://localhost:8080/iiq/scim/v2/Users/c7a7347a7fe71e69077ee75f5d1f1237"
}
},
"meta": {
"created": "2022-02-11T01:34:04.074-05:00",
"location": "http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b",
"lastModified": "2022-02-11T01:08:45.866-05:00",
"version": "W\"1644561244074\"",
"resourceType": "User"
},
"schemas": [
"urn:ietf:params:scim:schemas:sailpoint:1.0:User",
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
]
}
]
}
Authorization: http
name: basicAuthtype: httpscheme: basic
- goSailPoint SDK
- powershellSailPoint SDK
- pythonSailPoint SDK
- csharp
- curl
- dart
- http
- java
- javascript
- kotlin
- c
- nodejs
- objective-c
- ocaml
- php
- r
- ruby
- rust
- shell
- swift
- NATIVE
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:8080/identityiq/scim/v2/Users"
method := "GET"
client := &http.Client {
}
req, err := http.NewRequest(method, url, nil)
if err != nil {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()
body, err := io.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}