Jump to

• Request
• Response

Get global users

get

/ec-auth-svc/rest/v2.0/globalusers

Retrieves global users. Results can be filtered assigned or unassigned users.

Request

Query Parameters

• includeRemoved: string
  Result should include removed objects.

  Default Value: N

  Example:

  N

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object DisplayUserDtoV3
  Authorized User Info with extended attributes, audit and versioning. Extends DisplayUserDto2.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DisplayUserDtoV3"
    }
}

Nested Schema : DisplayUserDtoV3

Type: object

Authorized User Info with extended attributes, audit and versioning. Extends DisplayUserDto2.

Show Source

• comment: string
  Free comment regarding the user or change.

  Example: Initial bulk upload
• emailAddress: string
  User's email address.

  Example: [e-mail]
• externalId: string
  External identifier for the user (from source system).

  Example: EXT123456
• firstName: string
  User's first name.

  Example: Alice
• id: string
  Unique identifier for the user.

  Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
• isSystemUser: boolean
  Indicates if this is a system user.

  Example: true
• lastName: string
  User's last name.

  Example: Brown
• objectVersionNumber: number (double)
  Version number for the user object.

  Example: 2
• operationType: string
  Type of operation performed (e.g., CREATE, UPDATE, DELETE).

  Example: CREATE
• reason: string
  Reason for last update/change to user.

  Example: User promoted to admin
• softwareVersionNumber: number (double)
  Version number for the software.

  Example: 1.5
• userId: string (uuid)
  Alternate user UUID for versioning and reference.
• userName: string
  User's login name.

  Example: alicebrown
• versionEnd: string (date-time)
  Timestamp for when this version of the user record ended.

  Example: 2024-01-01T10:00:00Z
• versionStart: string (date-time)
  Timestamp for when this version of the user record started.

  Example: 2023-01-01T10:00:00Z
• workPhone: string
  Work phone number for the user.

  Example: [phone]

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier for the user.",
            "example":"1BC29B36F5D64B1B95F4BDBBCEA481BE"
        },
        "firstName":{
            "type":"string",
            "description":"User's first name.",
            "example":"Alice"
        },
        "lastName":{
            "type":"string",
            "description":"User's last name.",
            "example":"Brown"
        },
        "userName":{
            "type":"string",
            "description":"User's login name.",
            "example":"alicebrown"
        },
        "emailAddress":{
            "type":"string",
            "description":"User's email address.",
            "example":"[e-mail]"
        },
        "workPhone":{
            "type":"string",
            "description":"Work phone number for the user.",
            "example":"[phone]"
        },
        "externalId":{
            "type":"string",
            "description":"External identifier for the user (from source system).",
            "example":"EXT123456"
        },
        "isSystemUser":{
            "type":"boolean",
            "description":"Indicates if this is a system user.",
            "example":true
        },
        "versionStart":{
            "type":"string",
            "description":"Timestamp for when this version of the user record started.",
            "format":"date-time",
            "example":"2023-01-01T10:00:00Z"
        },
        "versionEnd":{
            "type":"string",
            "description":"Timestamp for when this version of the user record ended.",
            "format":"date-time",
            "example":"2024-01-01T10:00:00Z"
        },
        "operationType":{
            "type":"string",
            "description":"Type of operation performed (e.g., CREATE, UPDATE, DELETE).",
            "example":"CREATE"
        },
        "userId":{
            "type":"string",
            "description":"Alternate user UUID for versioning and reference.",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Version number for the user object.",
            "format":"double",
            "example":2
        },
        "softwareVersionNumber":{
            "type":"number",
            "description":"Version number for the software.",
            "format":"double",
            "example":1.5
        },
        "reason":{
            "type":"string",
            "description":"Reason for last update/change to user.",
            "example":"User promoted to admin"
        },
        "comment":{
            "type":"string",
            "description":"Free comment regarding the user or change.",
            "example":"Initial bulk upload"
        }
    },
    "description":"Authorized User Info with extended attributes, audit and versioning. Extends DisplayUserDto2."
}

Examples

Select an example A list of users (including possible removed users)

400 Response

Bad request

Body ()

Root Schema : AuthResponse

Type: object

Generic API response wrapper containing result, error data, response version and status.

Show Source

• errorData: object ErrorResponseData
• result: object result
  Result data of the API response; actual type depends on the API
• status: string (none)
  Indicates request success ("success") or failure ("failure").

  Example: success
• version: integer (int32)
  Version of the response schema.

  Example: 1

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Indicates request success (\"success\") or failure (\"failure\").",
            "format":"none",
            "example":"success"
        },
        "result":{
            "type":"object",
            "description":"Result data of the API response; actual type depends on the API",
            "example":null
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "description":"Version of the response schema.",
            "format":"int32",
            "example":1
        }
    },
    "description":"Generic API response wrapper containing result, error data, response version and status."
}

Nested Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Result data of the API response; actual type depends on the API

Example:

oracle.doceng.json.BetterJsonNull@1466a41f

Nested Schema : details

Type: object

Back to Top