Jump to

• Request
• Response
• Examples

Authenticate user

post

/oiri/api/v1/authenticate/{mode}

and return user information and JWT token.Additionally when mode is set to session then session ID is returned in a cookie named `JSESSIONID`.

Request

Path Parameters

• mode: string
  Mode type: * `session` - On successful user authentication return session ID in a cookie named JSESSIONID * `token` - On successful user authentication return JWT token

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• password(optional): string
• username(optional): string

{
    "properties":{
        "username":{
            "type":"string"
        },
        "password":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successfully authenticated. If mode in request is session then session ID is returned in a cookie named `JSESSIONID`. You need to include this cookie in subsequent requests. If mode in request is set to token return Token.

Headers

• Set-Cookie:

Body ()

Root Schema : AuthenticationResponse

Type: object

Show Source

• authenticated(optional): boolean
• token(optional): object Token
• user(optional): object User

{
    "properties":{
        "authenticated":{
            "type":"boolean"
        },
        "user":{
            "$ref":"#/components/schemas/User"
        },
        "token":{
            "$ref":"#/components/schemas/Token"
        }
    }
}

Nested Schema : Token

Type: object

Show Source

• accessToken(optional): string
• expiresIn(optional): string
• tokenType(optional): string

{
    "properties":{
        "expiresIn":{
            "type":"string"
        },
        "tokenType":{
            "type":"string"
        },
        "accessToken":{
            "type":"string"
        }
    }
}

Nested Schema : User

Type: object

Show Source

• email(optional): string
• firstName(optional): string
• lastName(optional): string
• roles(optional): array roles
• status(optional): boolean
• userLogin(optional): string

{
    "properties":{
        "userLogin":{
            "type":"string"
        },
        "firstName":{
            "type":"string"
        },
        "lastName":{
            "type":"string"
        },
        "email":{
            "type":"string"
        },
        "status":{
            "type":"boolean"
        },
        "roles":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : roles

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

400 Response

Bad request

Body ()

Root Schema : Error

Type: object

Show Source

• code: string
• message: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

401 Response

Unauthorized

Body ()

Root Schema : Error

Type: object

Show Source

• code: string
• message: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

Back to Top

Examples

The following example shows how to authenticate a user using cURL.

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json" \
"http://localhost:port/oiri/api/v1/authenticate/session"  -d

Example of the Request Body

The following is an example of the request body in JSON format.

{
username: "rfrost",
password: "USER_PASSWORD"
}

Example of the Response Body

The following is an example of the response body in JSON format.

{"authenticated": true,
"user": {
     "userLogin": "RFROST",
     "name": "Robert Frost",
     "roles": ["OIRIRoleEngineer"],
     "email": "[e-mail]",
     "active": true },
"token": {
     "expiresIn": "1619012554000",
      "tokenType": "Bearer",
      "accessToken":"eyJraWQiOiJvaWkiLCJhbGciOiJSUzI1NiJ9.eyJpc3MiO
iJ3d3cub3JhY2xlLmNvbSIsImF1ZCI6Ind3dy5vcmFjbGUuY29tIiwiZXhwIjoxNjE5MDEyNTU0LCJqdGkiOiJsQWxZdGxWaUpRTVVTTWtVZWdNQTZ3IiwiaWF0IjoxNjE4OTk4MTU0LCJzdWIiOiJSb2JlcnQgRnJvc3QiLCJlbWFpbCI6ImFkbWluQG9yYWNsZS5jb20iLCJ1c2VyTG9naW4iOiJBRE1JTiIsInJvbGVzIjpbIk9yY2xPSVJJUm9sZUVuZ2luZWVyIl19.WwyaYNiB9SKo8PzJfdEDniGyKZzLV23kinp5Rg8LOwt409EHFRvVGDeHYFr0iV3Tp5I57i9G5cJ_yIi2A2fQ5nc4KbrVN-uVBni2fwrbm-88EsniZanr0OFZi98vBmnF-gbSxuuepwfesrRk78xvg-KEelfPZGzprg1T-_TcKxaj573iQgp1MRwVmCj5ElLwXIYutEVpcMBUorGKDe_ZbE5MNERAHzPqvEUs-WTbqhfLdbaJZ6t_WQ9JdEc-hfOJGo_ufbmM99w0UDC_Pd26H9DxivEOTBlXSlqfJPR1gNsWOIyu5EHiMdlCOPPF0knw8y_ISWsM_H4AlPMny16J8w"}
}

Back to Top