Jump to

• Request
• Response

v1.0

get

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

Deprecated: Use '/v2.0/userinfo' instead. The v2 endpoint returns additional attribute fields and expanded user info. This endpoint returns user identity and global rights as in earlier API version. Suggested alternate: /v2.0/userinfo (adds 'userAttributes', returns UUID as 'userId', plus other improvements).

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : UserInfoDto

Type: object

User information (v1): identity and rights.

Show Source

• emailAddress: string (email)
  Email address of the user.

  Example: [e-mail]
• firstName: string
  First name of the user.

  Example: Alice
• globalRights: array globalRights
  Unique Items Required: true

  Set of global rights for the user.
• lastName: string
  Last name of the user.

  Example: Smith

{
    "type":"object",
    "properties":{
        "firstName":{
            "type":"string",
            "description":"First name of the user.",
            "example":"Alice"
        },
        "lastName":{
            "type":"string",
            "description":"Last name of the user.",
            "example":"Smith"
        },
        "emailAddress":{
            "type":"string",
            "description":"Email address of the user.",
            "format":"email",
            "example":"[e-mail]"
        },
        "globalRights":{
            "uniqueItems":true,
            "type":"array",
            "description":"Set of global rights for the user.",
            "example":[
                "StudyStatePost",
                "OrsSiteShipmentPost"
            ],
            "items":{
                "type":"string",
                "description":"Set of global rights for the user.",
                "example":"[\"StudyStatePost\",\"OrsSiteShipmentPost\"]"
            }
        }
    },
    "description":"User information (v1): identity and rights."
}

Nested Schema : globalRights

Type: array

Unique Items Required: true

Set of global rights for the user.

Show Source

• Array of: string
  Set of global rights for the user.

  Example: ["StudyStatePost","OrsSiteShipmentPost"]

{
    "uniqueItems":true,
    "type":"array",
    "description":"Set of global rights for the user.",
    "example":[
        "StudyStatePost",
        "OrsSiteShipmentPost"
    ],
    "items":{
        "type":"string",
        "description":"Set of global rights for the user.",
        "example":"[\"StudyStatePost\",\"OrsSiteShipmentPost\"]"
    }
}

Example:

[
    "StudyStatePost",
    "OrsSiteShipmentPost"
]

Examples

Select an example UserInfoDtoExample

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