ジャンプ先

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

秘密キーの作成

post

/oaa/runtime/totp/key/v1/

このAPIを使用して、ユーザーのTOTP秘密キーを作成します。

リクエスト

この操作にはリクエスト・パラメータはありません。

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

• application/xml
• application/json

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

ルート・スキーマ: schema

型: object

ユーザーの秘密キーを作成するための詳細。

ソースの表示

• deviceName: string
  デバイスの名前。これはユーザーにわかりやすくする必要があります。
• groupName(required): string
  ユーザーのグループ名。
• uniqueUserId: string
  外部システムのユーザーの不変ID。これが存在する場合は、userId + groupIdの組合せよりも優先されます。
• userName(required): string
  ユーザーのユーザー名。

{
    "required":[
        "groupName",
        "userName"
    ],
    "type":"object",
    "properties":{
        "groupName":{
            "type":"string",
            "description":"User's group name."
        },
        "userName":{
            "type":"string",
            "description":"User's username."
        },
        "deviceName":{
            "type":"string",
            "description":"Name of the device. This should be recognizable by the user."
        },
        "uniqueUserId":{
            "type":"string",
            "description":"Immutable ID of the user in the external systems. If this is present, then it takes precedence over userId + groupId combination."
        }
    },
    "description":"Details for creating a secret key for a user."
}

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

ルート・スキーマ: schema

型: object

ユーザーの秘密キーを作成するための詳細。

ソースの表示

• deviceName: string
  デバイスの名前。これはユーザーにわかりやすくする必要があります。
• groupName(required): string
  ユーザーのグループ名。
• uniqueUserId: string
  外部システムのユーザーの不変ID。これが存在する場合は、userId + groupIdの組合せよりも優先されます。
• userName(required): string
  ユーザーのユーザー名。

{
    "required":[
        "groupName",
        "userName"
    ],
    "type":"object",
    "properties":{
        "groupName":{
            "type":"string",
            "description":"User's group name."
        },
        "userName":{
            "type":"string",
            "description":"User's username."
        },
        "deviceName":{
            "type":"string",
            "description":"Name of the device. This should be recognizable by the user."
        },
        "uniqueUserId":{
            "type":"string",
            "description":"Immutable ID of the user in the external systems. If this is present, then it takes precedence over userId + groupId combination."
        }
    },
    "description":"Details for creating a secret key for a user."
}

先頭に戻る

レスポンス

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

• application/xml
• application/json
• text/plain

201レスポンス

秘密キーが作成されました。

本文()

ルート・スキーマ: SecretKey

型: object

ユーザーの秘密キー。

ソースの表示

• secret_key(required): string
  ユーザーの秘密キー。

{
    "required":[
        "secret_key"
    ],
    "type":"object",
    "properties":{
        "secret_key":{
            "type":"string",
            "description":"Secret key of user."
        }
    },
    "description":"A user's secret key."
}

400レスポンス

不正なリクエスト

401レスポンス

未認可

403レスポンス

秘密キーを登録できませんでした

本文()

ルート・スキーマ: SecretKeyAPIResponse

型: object

ソースの表示

• responseCode: string
• responseMessage: string

{
    "type":"object",
    "properties":{
        "responseCode":{
            "type":"string"
        },
        "responseMessage":{
            "type":"string"
        }
    }
}

422レスポンス

リクエストされたユーザー情報が見つかりません

本文()

ルート・スキーマ: SecretKeyAPIResponse

型: object

ソースの表示

• responseCode: string
• responseMessage: string

{
    "type":"object",
    "properties":{
        "responseCode":{
            "type":"string"
        },
        "responseMessage":{
            "type":"string"
        }
    }
}

500レスポンス

内部サーバー・エラー

本文()

ルート・スキーマ: SecretKeyAPIResponse

型: object

ソースの表示

• responseCode: string
• responseMessage: string

{
    "type":"object",
    "properties":{
        "responseCode":{
            "type":"string"
        },
        "responseMessage":{
            "type":"string"
        }
    }
}

503レスポンス

サービス使用不可

本文()

ルート・スキーマ: SecretKeyAPIResponse

型: object

ソースの表示

• responseCode: string
• responseMessage: string

{
    "type":"object",
    "properties":{
        "responseCode":{
            "type":"string"
        },
        "responseMessage":{
            "type":"string"
        }
    }
}

先頭に戻る

例

次の例は、ユーザーの時間ベースのワンタイム・パスワード(TOTP)秘密キーを作成するサンプルのリクエストとレスポンスを示します。

JSON形式でTOTPを作成するcURLコマンド

curl --location --request POST '<OAAService>/oaa/runtime/totp/key/v1/' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data '{
    "groupName": "testfinanceapp4",
    "userName": "testuser4",
    "deviceName": "secretKeyApiTest"
}'

JSON形式のサンプル・レスポンス

{"secret_key": "4Z5CQ6ET3KB22YV2"}

XML形式でTOTPを作成するcURLコマンド

curl --location --request POST '<OAAService>/oaa/runtime/totp/key/v1/' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data '<?xml version="1.0" encoding="UTF-8" ?>
 <CreateSecretKeyRequest>
     <groupName>testfinanceapp4</groupName>
     <userName>testuser4</userName>
     <deviceName>secretKeyApiTest</deviceName>
 </CreateSecretKeyRequest>'

XML形式のサンプル・レスポンス

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <SecretKey>
     <secret_key>4Z5CQ6ET3KB22YV2</secret_key>
 </SecretKey>

先頭に戻る