Skip to main content

Returns all User resources.

GET 

http://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

    filter string

    Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported.

    sortBy string

    Allows sorting the results by a resource's attributes.

    sortOrder string

    Determines what order to sort results in.

    Default value: ascending
    startIndex integer

    Determines the starting index of the result set.

    Default value: 1
    count integer

    Specifies the number of results per page.

    Default value: 1000
    attributes string

    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.

    excludedAttributes string

    A comma-separated list of attributes to exclude from the response. Some attributes cannot be excluded.

Responses

Returns all SCIM User resources.

Schema
    totalResultsinteger

    Number of User resources returned

    Example: 18
    startIndexinteger

    The starting index of the resource set list. Can be specified with startIndex query parameter.

    Example: 1
    schemasstring[]

    SCIM Schema used for response.

    Example: ["urn:ietf:params:scim:api:messages:2.0:ListResponse"]
    Resources undefined[]
  • Array [
  • idstring

    IdentityIQ id of the User.

    Example: c0b4568a4fe7458c434ee77d1fbt156b
    userNamestring

    Unique identifier for the User. Typically used to directly authenticate to the service provider. Each User MUST include a non-empty userName value. This identifier MUST be unique across the entire set of Users. Cannot be changed.

    Example: Mock.User
    name

    The components of the User’s real name. Providers may return just the full name as a single string in the formatted sub-attribute, or they MAY return just the individual component attributes using the other sub-attributes, or they MAY return both. If both variants are returned, they SHOULD be describing the same name, with the formatted name indicating how the component attributes should be combined.

    formattedstring

    The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.

    Example: Ms. Barbara J Jensen, III
    familyNamestring

    The family name of the User, or Last Name in most Western languages

    Example: Jensen
    givenNamestring

    The given name of the User, or First Name in most Western languages

    Example: Barbara
    displayNamestring

    The name of the User, suitable for display to end-users. The name should be the full name of the User being described.

    Example: Barbara Jensen
    userTypestring

    The type of the User, identifying the relationship between the organization and the User.

    Example: employee
    activeboolean

    A Boolean value indicating the User’s administrative status.

    Example: true
    emails undefined[]

    Email addresses for the user. The value SHOULD be canonicalized by the Service Provider, e.g., bjensen@example.com instead of bjensen@EXAMPLE.COM. Canonical Type values of work, home, and other.

  • Array [
  • typestring

    Type of email address (work, home, other).

    Example: work
    valueemail

    Canonicalized email address.

    Example: Barbara.Jensen@example.com
    primaryboolean

    A Boolean value indicating the primary e-mail address. The primary attribute value 'true' MUST appear no more than once.

    Example: true
  • ]
  • urn:ietf:params:scim:schemas:sailpoint:1.0:User object

    Additional attributes of the User.

    accounts undefined[]

    Simple representation of the Account (or Link) ResourceType.

  • Array [
  • displayNamestring

    The display name of the Account.

    Example: Bob.Smith
    valuestring

    The id of the SCIM resource representing the Account.

    Example: c0a7778b7ef71e79817ee74e6a1f0444
    $refstring

    The URI of the SCIM resource representing the Account.

    Example: http://localhost:8080/iiq/scim/v2/Accounts/c0a7778b7ef71e79817ee74e6a1f0444
  • ]
  • entitlements undefined[]

    Entitlements of the User. Returned in response only if requested using the 'attributes' query parameter.

  • Array [
  • valuestring

    The value of the Entitlement.

    Example: groupmbr
    displaystring

    The display name of the Entitlement.

    Example: HelpDesk
    typestring

    The type of Entitlement (Entitlement, Permission, etc.).

    Example: Permission
    applicationstring

    The name of the Application this Entitlement applies to.

    Example: ADMockApp
    accountNamestring

    The account this Entitlement was sourced from.

    Example: CN=Barbara Jensen,OU=Taipei,OU=Asia-Pacific,DC=example,DC=com
    $refstring

    The URI of the SCIM resource representing the Entitlement.

    Example: http://localhost:8080/iiq/scim/v2/Entitlements/c0a7777a7f74744d817e74fc12362c67
  • ]
  • roles undefined[]

    Roles of the User. Returned only if requested. Returned in response only if requested using the 'attributes' query parameter.

  • Array [
  • valuestring

    The value of the Role.

    Example: detectedRoles
    displaystring

    The display name of the Role.

    Example: User - IT
    typestring

    The type of Role (IT, Business, etc.).

    Example: it
    acquiredstring

    Indicates how this Role was acquired. Assigned or Detected.

    Example: Assigned
    applicationstring

    The name of the Application where this Role came from.

    Example: Active_Directory
    accountNamestring

    The name of the Account this Role was sourced from.

    Example: CN=Barbara Jensen,OU=Taipei,OU=Asia-Pacific,DC=example,DC=com
    $refstring

    The URI of the SCIM resource representing the Role.

    Example: http://localhost:8080/iiq/scim/v2/Roles/c0a7777a7f74744d817e74fc12362c67
  • ]
  • capabilitiesstring[]

    Capabilities assigned to this User.

    Example: ["SystemAdministrator"]
    riskScoreinteger

    Composite Risk Score of this User.

    Example: 125
    isManagerboolean

    A Boolean value that determines if this User is a manager.

    Example: false
    administrator

    The Administrator of the RPA or Service Account. This attribute is only applicable if the User type is RPA/Bots or Service.

    displayNamestring

    The display name of the Administrator of RPA user or Service account.

    Example: Bob Smith
    valuestring

    The id of the SCIM resource representing the Administrator of RPA user or Service account.

    Example: c0a7777a7f74744d817e74fc12362c67O
    $refstring

    The URI of the SCIM resource representing the Administrator of RPA user or Service Account.

    Example: http://localhost:8080/iiq/scim/v2/Users/c0a7777a7f74744d817e74fc12362c67
    softwareVersionstring

    The software version of the RPA/Bots.

    Example: 7.3
    empIdstring

    Employee id associated with this User.

    Example: 1b2a3c
    dnstring

    Distinguished name for this User.

    Example: cn=Bob Smith,ou=services
    regionstring

    The region this User is assigned to.

    Example: Americas
    regionOwner

    The User who owns the region that this resource (User) belongs to.

    displayNamestring

    Display name of the region owner.

    Example: Joe Smith
    valuestring

    The id of the region owner.

    Example: c0b4568a4fe7458c434ee77d1fbt156b
    $refstring

    URI reference of the region owner resource.

    Example: http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b
    locationstring

    The location this User is assigned to.

    Example: Singapore
    locationOwner object

    The User who owns the location that this resource (User) belongs to.

    displayNamestring

    Display name of the location owner.

    Example: Bob Smith
    valuestring

    The id of the location owner.

    Example: c0a7778b7ef71e79817ee74e6a1f0444
    $refstring

    URI reference to the location owner resource.

    Example: http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444
    Departmentstring

    Department this User is assigned to.

    Example: Regional Operations
    costcenterstring[]

    Cost centers this User is associated with.

    Example: ["CC01","DD02"]
    jobtitlestring

    Job title given to this User.

    Example: Internal Audit Manager
    lastRefreshdate-time

    Datetime representation of the last refresh for this User.

    urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

    Enterprise User Schema. Contains the manager of the User.

    manager

    Manager of the User.

    displayNamestring

    Display name of the User's manager.

    Example: Bob Smith
    valuestring

    The id of the SCIM resource representing the User’s manager.

    Example: c7a7347a7fe71e69077ee75f5d1f1237
    $refstring

    The URI of the SCIM resource representing the User’s manager.

    Example: http://localhost:8080/iiq/scim/v2/Users/c7a7347a7fe71e69077ee75f5d1f1237
    meta

    Metadata of the resource.

    createddate-time

    Datetime this resource was created.

    Example: 2022-02-11T01:34:04.074-05:00
    locationstring

    The location of the resource.

    Example: http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b
    lastModifieddate-time

    Datetime the resource was last modified.

    Example: 2022-02-11T01:08:45.866-05:00
    versionstring

    The version of the resource.

    Example: W"1644561244074"
    resourceTypestring

    The SCIM resource type.

    Example: User
    schemasstring[]

    The schemas involved in the SCIM resource.

    Example: ["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
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))
}
Request Collapse all
Base URL
http://localhost:8080/identityiq/scim/v2
Auth
Parameters
— query
— query
— query
— query
— query
— query
— query
ResponseClear

Click the Send API Request button above and see the response here!