Jump to

• Request
• Response

Request a Token v3

post

/jderest/v3/orchestrator/jde-login

Request an AIS token to be used for subsequent requests. Authentication is performed with given credentials and a session token is returned.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

• jde-AIS-Auth-Device(optional): string
  Device Name
• jde-AIS-Auth-Environment(optional): string
  Environment
• jde-AIS-Auth-Role(optional): string
  Role

Body ()

The input to a token request.

Root Schema : LoginRequest

Type: object

The input to a token request.

Show Source

• applicationName(optional): string
  A proxy application associated with a mobile or ADF app. If you pass this value the login service will attempt to get security and processing options for the application.
• deviceName(optional): string
  An identifier for the device making the service call. If not provided, the requesting IP address is used.
• environment(optional): string
  Specify the environment to use for login. If not specified, the default environment configured for the AIS Server will be used.
• jasserver(optional): 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(optional): string
  The JD Edwards EnterpriseOne password, which is required if other authentication methods are not being used.
• psToken(optional): string
  Used for logging in with psToken. Primarily used by the HTML Server to establish a session with the AIS Server.
• role(optional): string
  The role to use for login. If not specified, the default role configured for the AIS Server will be used.
• token(optional): string
  The AIS token, which is required if other authentication methods are not being used.
• username(optional): 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."
        },
        "applicationName":{
            "type":"string",
            "description":"A proxy application associated with a mobile or ADF app.  If you pass this value the login service will attempt to get security and processing options for the application."
        }
    },
    "description":"The input to a token request."
}

Security

• Authorization: apiKey
  Type: apiKey

  Description: JWT Token
• basicAuth: basic
  Type: basic

  Description:

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Successful Execution

400 Response

Bad Request - Invalid JSON Input

403 Response

Authorization Failure

405 Response

Allowed Hosts on the HTML server is not configured to accept requests from this AIS Server

415 Response

Invalid Content-Type Header

445 Response

Mobile SSO Failed

446 Response

Mobile SSO Requested, but SSO is not Enabled on this AIS Server

500 Response

Server Failed to Process Request

Back to Top