Jump to

• Request
• Response
• Examples

Validate Token v2

post

/v2/tokenrequest/validate

Determine if the the token passed is still valid.

Request

Supported Media Types

• application/json

Header Parameters

• jde-AIS-Auth: string
  Token
• jde-AIS-Auth-Device: string
  Device Name
• jde-AIS-MonitorOnStart: boolean
  Monitor on Start
• jde-AIS-MonitorRequest: string
  Monitor Request

  Allowed Values: [ "monitorRequest", "monitorRequestIO" ]

Body ()

The input to the tokenrequest/validate service.

Root Schema : ValidateRequest

Type: object

The input to the tokenrequest/validate service.

Show Source

• deviceName: string
  An identifier for the device making the service call. If not provided, the requesting IP address is used.
• environment: string
  Specify the environment to use for login. If not specified, the default environment configured for the AIS Server will be used.
• externalJwt: string
• jasserver: string
  The HTML (JAS) Server to use for login. If not specified, the default HTML Server configured for the AIS Server will be used.
• password: string
  The JD Edwards EnterpriseOne password, which is required if other authentication methods are not being used.
• psToken: string
  Used for logging in with psToken. Primarily used by the HTML Server to establish a session with the AIS Server.
• role: string
  The role to use for login. If not specified, the default role configured for the AIS Server will be used.
• token: string
  The AIS token, which is required if other authentication methods are not being used.
• touch: boolean
  Touch the user session to extend the session timeout.
• username: string
  JD Edwards EnterpriseOne username, which is required if other authentication methods are not being used.

{
    "type":"object",
    "properties":{
        "environment":{
            "type":"string",
            "description":"Specify the environment to use for login. If not specified, the default environment configured for the AIS Server will be used."
        },
        "role":{
            "type":"string",
            "description":"The role to use for login. If not specified, the default role configured for the AIS Server will be used."
        },
        "jasserver":{
            "type":"string",
            "description":"The HTML (JAS) Server to use for login. If not specified, the default HTML Server configured for the AIS Server will be used."
        },
        "token":{
            "type":"string",
            "description":"The AIS token, which is required if other authentication methods are not being used."
        },
        "deviceName":{
            "type":"string",
            "description":"An identifier for the device making the service call. If not provided, the requesting IP address is used."
        },
        "psToken":{
            "type":"string",
            "description":"Used for logging in with psToken. Primarily used by the HTML Server to establish a session with the AIS Server."
        },
        "username":{
            "type":"string",
            "description":"JD Edwards EnterpriseOne username, which is required if other authentication methods are not being used."
        },
        "password":{
            "type":"string",
            "description":"The JD Edwards EnterpriseOne password, which is required if other authentication methods are not being used."
        },
        "touch":{
            "type":"boolean",
            "description":"Touch the user session to extend the session timeout."
        },
        "externalJwt":{
            "type":"string"
        }
    },
    "description":"The input to the tokenrequest/validate service."
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Successful Execution - Token is Valid

400 Response

Bad Request - Invalid JSON Input

403 Response

Token is Invalid

415 Response

Invalid Content-Type Header - Must use application/json

444 Response

Invalid Token

Body ()

Root Schema : ServiceErrorResponse

Type: object

Error Response

Show Source

• errorText: string
• exception: string
  The class of the exception if an exception was thrown.
• exceptionId: string
  ExceptionId, only if an exception record was written to the F980060
• message: string
  Details about the error.
• status: string
  Allowed Values: [ "ERROR", "WARNING" ]

  Status determined by exception handling
• timeStamp: string
  The timestamp indicating the time the error message was returned.
• type: string
  Optional type of error
• userDefinedErrorText: string
  Optional error text added to an orchestration step.

{
    "type":"object",
    "properties":{
        "message":{
            "type":"string",
            "description":"Details about the error."
        },
        "exception":{
            "type":"string",
            "description":"The class of the exception if an exception was thrown."
        },
        "timeStamp":{
            "type":"string",
            "description":"The timestamp indicating the time the error message was returned."
        },
        "userDefinedErrorText":{
            "type":"string",
            "description":"Optional error text added to an orchestration step."
        },
        "type":{
            "type":"string",
            "description":"Optional type of error"
        },
        "errorText":{
            "type":"string"
        },
        "exceptionId":{
            "type":"string",
            "description":"ExceptionId, only if an exception record was written to the F980060"
        },
        "status":{
            "type":"string",
            "description":"Status determined by exception handling",
            "enum":[
                "ERROR",
                "WARNING"
            ]
        }
    },
    "description":"Error Response"
}

500 Response

Server Failed to Process Request

Body ()

Root Schema : ServiceErrorResponse

Type: object

Error Response

Show Source

• errorText: string
• exception: string
  The class of the exception if an exception was thrown.
• exceptionId: string
  ExceptionId, only if an exception record was written to the F980060
• message: string
  Details about the error.
• status: string
  Allowed Values: [ "ERROR", "WARNING" ]

  Status determined by exception handling
• timeStamp: string
  The timestamp indicating the time the error message was returned.
• type: string
  Optional type of error
• userDefinedErrorText: string
  Optional error text added to an orchestration step.

{
    "type":"object",
    "properties":{
        "message":{
            "type":"string",
            "description":"Details about the error."
        },
        "exception":{
            "type":"string",
            "description":"The class of the exception if an exception was thrown."
        },
        "timeStamp":{
            "type":"string",
            "description":"The timestamp indicating the time the error message was returned."
        },
        "userDefinedErrorText":{
            "type":"string",
            "description":"Optional error text added to an orchestration step."
        },
        "type":{
            "type":"string",
            "description":"Optional type of error"
        },
        "errorText":{
            "type":"string"
        },
        "exceptionId":{
            "type":"string",
            "description":"ExceptionId, only if an exception record was written to the F980060"
        },
        "status":{
            "type":"string",
            "description":"Status determined by exception handling",
            "enum":[
                "ERROR",
                "WARNING"
            ]
        }
    },
    "description":"Error Response"
}

Back to Top

Examples

Example Request - Basic

The following shows an example of a token validation request which is used to determine if a token is still valid.

curl -X POST -H "Content-Type:application/json" http://ais_server_url/jderest/v2/tokenrequest/validate -d
{
    "token": "044RCAgER+J6ZDUAZgotcr4Xju0x33EUSOJZzW8xFc2Gtk=MDE5MDEzMzQzNDYxMzc3NTc5ODc3NDA3NTEwLjEzOS4xMTEuODMxNTE2MTE1MzQ4Mjgw"
}

Example Response - Valid

The following example shows the contents of the response body when the token is valid. The response status code will be 200.

{ "isValidSession":true }

Example Response - Invalid

The following example shows one possible value for the response body when the token is invalid. It is best to use the status code for consistent determination of token validity. Anything other than a 200 status is an invalid token.

{
  "message" : "Invalid Token",
  "exception" : "java.lang.Exception",
  "timeStamp" : "2018-01-16:15.17.29"
}

Back to Top