Jump to

• Request
• Response

[Deprecated]: v1.0

get

/ec-auth-svc/rest/v1.0/authusers

Deprecated: Use /v3.0/authusers for latest features and optimized performance. This endpoint retrieves users with optional search, pagination, or filtering. The latest version supports advanced search and user management capabilities with new DTOs. See v3 APIs for details.

Request

Query Parameters

• firstResult: integer(int32)
  Start index (zero-based) for paginated results. Example: 0

  Example:

  0

• rowsToReturn: integer(int32)
  Number of user records to return in response. Example: 25

  Example:

  25

• searchString: string
  Free text string to filter/search users by name, email, or attributes. Example: "smith"

  Example:

  smith

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success: List of users in the system. Deprecated: Use the v2 or v3 endpoint for latest structure.

Body ()

Root Schema : DisplayUserListDto

Type: object

Paginated result set of users for a global role.

Show Source

• firstUserReturned: integer (int32)
  Index of the first user returned in this page.

  Example: 1
• users: object users
  User details including name, username, and email address.
• usersFound: integer (int32)
  The total number of users found matching the query.

  Example: 2
• usersReturned: integer (int32)
  How many users are present in this response.

  Example: 2

{
    "type":"object",
    "properties":{
        "usersFound":{
            "type":"integer",
            "description":"The total number of users found matching the query.",
            "format":"int32",
            "example":2
        },
        "firstUserReturned":{
            "type":"integer",
            "description":"Index of the first user returned in this page.",
            "format":"int32",
            "example":1
        },
        "usersReturned":{
            "type":"integer",
            "description":"How many users are present in this response.",
            "format":"int32",
            "example":2
        },
        "users":{
            "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]"
                }
            },
            "description":"User details including name, username, and email address.",
            "example":[
                {
                    "id":"1BC29B36F5D64B1B95F4BDBBCEA481BE",
                    "firstName":"Alice",
                    "lastName":"Brown",
                    "userName":"alicebrown",
                    "emailAddress":"[e-mail]"
                }
            ]
        }
    },
    "description":"Paginated result set of users for a global role."
}

Nested Schema : users

Type: object

User details including name, username, and email address.

Show Source

• emailAddress: string
  User's email address.

  Example: [e-mail]
• firstName: string
  User's first name.

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

  Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
• lastName: string
  User's last name.

  Example: Brown
• userName: string
  User's login name.

  Example: alicebrown

{
    "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]"
        }
    },
    "description":"User details including name, username, and email address.",
    "example":[
        {
            "id":"1BC29B36F5D64B1B95F4BDBBCEA481BE",
            "firstName":"Alice",
            "lastName":"Brown",
            "userName":"alicebrown",
            "emailAddress":"[e-mail]"
        }
    ]
}

Example:

[
    {
        "id":"1BC29B36F5D64B1B95F4BDBBCEA481BE",
        "firstName":"Alice",
        "lastName":"Brown",
        "userName":"alicebrown",
        "emailAddress":"[e-mail]"
    }
]

Examples

Select an example Sample response for user list

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
  Title: ErrorResponseData

  Error Response Details Information
• 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

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

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

Example:

oracle.doceng.json.BetterJsonNull@65719c12

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Back to Top