ジャンプ先

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

秘密キーの作成

post

/oaa/runtime/totp/key/v1/

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

リクエスト

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

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

• application/xml
• application/json

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

ルート・スキーマ: schema

型: object

ユーザーの秘密キーを作成するための詳細。userNameは必須パラメータです。APIコールは、正規のuniqueUserIdと、userNameおよびgroupNameを使用して行う必要があります。userNameおよびgroupNameが一意の場合、userNameおよびgroupNameを使用してコールを行うこともできます。

ソースの表示

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

{
    "type":"object",
    "description":"Details for creating a secret key for a user. userName is mandatory parameter. API call should be made with canonical uniqueUserId along with userName and groupName. If userName and groupName is unique, the call can also be made using userName and groupName.",
    "required":[
        "groupName",
        "userName"
    ],
    "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":"Canonical ID of the user. If this is present, then it takes precedence over userId + groupId combination."
        }
    }
}

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

ルート・スキーマ: schema

型: object

ユーザーの秘密キーを作成するための詳細。userNameは必須パラメータです。APIコールは、正規のuniqueUserIdと、userNameおよびgroupNameを使用して行う必要があります。userNameおよびgroupNameが一意の場合、userNameおよびgroupNameを使用してコールを行うこともできます。

ソースの表示

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

{
    "type":"object",
    "description":"Details for creating a secret key for a user. userName is mandatory parameter. API call should be made with canonical uniqueUserId along with userName and groupName. If userName and groupName is unique, the call can also be made using userName and groupName.",
    "required":[
        "groupName",
        "userName"
    ],
    "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":"Canonical ID of the user. If this is present, then it takes precedence over userId + groupId combination."
        }
    }
}

先頭に戻る

レスポンス

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

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

201レスポンス

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

本文()

ルート・スキーマ: SecretKey

型: object

ユーザーの秘密キー。

ソースの表示

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

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

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 '{
    "userName": "user1",
    "groupName": "financeapp",
    "uniqueUserId": "user1",
    "deviceName": "secretKeyApiTest2"
}'

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

{"secret_key":"2DXIBA4532JSI6WL"}

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>
    <userName>user1</userName>
    <groupName>financeapp</groupName>
    <uniqueUserId>user1</uniqueUserId>
    <deviceName>secretKeyApiTest</deviceName>
 </CreateSecretKeyRequest>'

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

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

先頭に戻る