ジャンプ先

• リクエスト
• レスポンス
• 例

ユーザーの認証

post

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

ユーザー情報およびJWTトークンを返します。また、モードがセッションに設定されている場合、セッションIDは`JSESSIONID`という名前のCookieに返されます。

リクエスト

パス・パラメータ

• mode: string
  モード・タイプ: * `session` - ユーザー認証に成功すると、名前が付けられたCookieにセッションIDが返されます JSESSIONID * `token` - ユーザー認証に成功すると、JWTトークンが返されます

サポートされているメディア・タイプ

• application/json

リクエスト本文 - application/json ()

ルート・スキーマ: schema

型: object

ソースを表示

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

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

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200レスポンス

正常に認証されました。リクエストのモードがセッションの場合、セッションIDは`JSESSIONID`という名前のCookieに返されます。このCookieを後続のリクエストに含める必要があります。リクエストのモードがトークンに設定されている場合、トークンを返します。

ヘッダー

• Set-Cookie:

Body ()

ルート・スキーマ: AuthenticationResponse

型: object

ソースを表示

• 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"
        }
    }
}

ネストされたスキーマ: Token

型: object

ソースを表示

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

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

ネストされたスキーマ: User

型: object

ソースを表示

• 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"
            }
        }
    }
}

ネストされたスキーマ: roles

型: array

ソースを表示

• 配列: string

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

400レスポンス

不正なリクエストです

Body ()

ルート・スキーマ: Error

型: object

ソースを表示

• code: string
• message: string

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

401レスポンス

認可されていません

Body ()

ルート・スキーマ: Error

型: object

ソースを表示

• code: string
• message: string

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

先頭に戻る

例

次の例は、cURLを使用してユーザーを認証する方法を示しています。

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

リクエスト本文の例

JSON形式のリクエスト本文の例を次に示します。

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

レスポンス本文の例

JSON形式のレスポンス本文の例を次に示します。

{"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"}
}

先頭に戻る