Jump to

• Request
• Response

v2.0

get

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

Retrieves details for the currently logged-in user in v2 format. Response includes the user's identity, all global rights, and the complete list of key/value attributes.

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 : UserInfoDtoV2

Type: object

User information with rights and attributes

Show Source

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

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

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

  Global rights assigned to the user.
• lastName: string
  Last name of the user.

  Example: Doe
• userAttributes: object userAttributes
  Key-value pair for user attribute
• userId: string
  User identifier.

  Example: A1234567890B1234567890C12345678E

{
    "type":"object",
    "properties":{
        "firstName":{
            "type":"string",
            "description":"First name of the user.",
            "example":"Jane"
        },
        "lastName":{
            "type":"string",
            "description":"Last name of the user.",
            "example":"Doe"
        },
        "emailAddress":{
            "type":"string",
            "description":"Email address of the user.",
            "format":"email",
            "example":"[e-mail]"
        },
        "globalRights":{
            "uniqueItems":true,
            "type":"array",
            "description":"Global rights assigned to the user.",
            "example":[
                "OrsSiteShipmentPost",
                "UpdateRecipe"
            ],
            "items":{
                "type":"string",
                "description":"Global rights assigned to the user.",
                "example":"[\"OrsSiteShipmentPost\",\"UpdateRecipe\"]"
            }
        },
        "userId":{
            "type":"string",
            "description":"User identifier.",
            "example":"A1234567890B1234567890C12345678E"
        },
        "userAttributes":{
            "type":"object",
            "properties":{
                "key":{
                    "type":"string",
                    "description":"The attribute key name",
                    "example":"Locale"
                },
                "value":{
                    "type":"string",
                    "description":"The value of the attribute",
                    "example":"en-US"
                }
            },
            "description":"Key-value pair for user attribute",
            "example":{
                "key":"Locale",
                "value":"en-US"
            }
        }
    },
    "description":"User information with rights and attributes"
}

Nested Schema : globalRights

Type: array

Unique Items Required: true

Global rights assigned to the user.

Show Source

• Array of: string
  Global rights assigned to the user.

  Example: ["OrsSiteShipmentPost","UpdateRecipe"]

{
    "uniqueItems":true,
    "type":"array",
    "description":"Global rights assigned to the user.",
    "example":[
        "OrsSiteShipmentPost",
        "UpdateRecipe"
    ],
    "items":{
        "type":"string",
        "description":"Global rights assigned to the user.",
        "example":"[\"OrsSiteShipmentPost\",\"UpdateRecipe\"]"
    }
}

Example:

[
    "OrsSiteShipmentPost",
    "UpdateRecipe"
]

Nested Schema : userAttributes

Type: object

Key-value pair for user attribute

Show Source

• key: string
  The attribute key name

  Example: Locale
• value: string
  The value of the attribute

  Example: en-US

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string",
            "description":"The attribute key name",
            "example":"Locale"
        },
        "value":{
            "type":"string",
            "description":"The value of the attribute",
            "example":"en-US"
        }
    },
    "description":"Key-value pair for user attribute",
    "example":{
        "key":"Locale",
        "value":"en-US"
    }
}

Example:

{
    "key":"Locale",
    "value":"en-US"
}

Examples

Select an example UserInfoDtoV2Example

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