1. Oracle GoldenGate Microservices REST API
  2. Tasks
  3. Common
  4. User Information

Retrieve Information

get

/services/{version}/currentuser

Required Role: User

Return the current user's identity information encoded in the request.

Request

Path Parameters
Back to Top

Response

Supported Media Types

200 Response

Body ()
Root Schema : Oracle GoldenGate Service current user's security information.
Type: object
Title: Oracle GoldenGate Service current user's security information.
Show Source
  • Allowed Values: [ "ogg:currentUser" ]
  • Allowed Values: [ "ogg.sca" ]
    The identifier of the intended audience
  • Allowed Values: [ "Basic", "x-Cert", "Bearer" ]
    The associated authentication model
  • Minimum Value: 0
    Maximum Value: 9223372036854776000
    Seconds until this JsonWebToken will expire
  • host
    Server host name or IP address
  • Minimum Value: 0
    Maximum Value: 9223372036854776000
    Date and time when this JsonWebToken was issued
  • Allowed Values: [ "ogg.sca" ]
    The issuer's identity
  • Allowed Values: [ "All", "Any", "User", "Operator", "Administrator", "Security" ]
    User's assigned role
  • Minimum Value: 0
    Maximum Value: 4294967295
    Default Value: 1800
    The maximum number of seconds an unexpired authorization session may be inactive before expiring. A session's inactivity time will be unlimited when sessionInactiveSeconds is set to 0.
  • Minimum Length: 1
    Maximum Length: 256
    Type identity of the this JsonWebToken
  • Minimum Length: 1
    Maximum Length: 30
    Name of the user for which role information is being requested
Nested Schema : host
Server host name or IP address
Match One
Show Source
  • Minimum Length: 1
    Maximum Length: 4095
    Pattern: ^(((([a-zA-Z0-9][-a-zA-Z0-9]{0,61})?[a-zA-Z0-9])[.])*([a-zA-Z][-a-zA-Z0-9]{0,61}[a-zA-Z0-9]|[a-zA-Z])[.]?)$
    Network host name
  • host-x-oneOf[1]
    Network IP address
Nested Schema : host-x-oneOf[1]
Network IP address
Match One
Show Source
  • Minimum Length: 7
    Maximum Length: 15
    Pattern: ^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)[.]){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$
    Network IPv4 address
  • Minimum Length: 1
    Maximum Length: 256
    Pattern: ^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:)))(%.+)?$
    Network IPv6 address
Example Response (application/json)
{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:11001/services/v2/currentuser",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:11001/services/v2/currentuser",
            "mediaType":"application/json",
            "rel":"self"
        },
        {
            "href":"http://localhost:11001/services/v2/metadata-catalog/currentuser",
            "mediaType":"application/schema+json",
            "rel":"describedby"
        }
    ],
    "messages":[
    ],
    "response":{
        "role":"Security",
        "host":"localhost",
        "issuer":"ogg.sca",
        "username":"oggadmin",
        "$schema":"ogg:currentUser",
        "type":"x-SCA-Authorization",
        "expiration":"3600",
        "authType":"Basic",
        "audience":"ogg.sca",
        "issuedAt":"1626194216"
    }
}
Back to Top