ジャンプ先

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

登録URLの作成

post

/oaa/runtime/totp/registrationurl/v1/

このAPIを使用して、TOTP登録URLを生成します。

リクエスト

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

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

• application/xml
• application/json

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

ルート・スキーマ: schema

型: object

TOTP登録URLを作成するための詳細。

ソースの表示

• 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 TOTP registration URL."
}

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

ルート・スキーマ: schema

型: object

TOTP登録URLを作成するための詳細。

ソースの表示

• 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 TOTP registration URL."
}

先頭に戻る

レスポンス

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

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

201レスポンス

登録URLが作成されました。

本文()

ルート・スキーマ: CreateTotpConfigResponse

型: object

ユーザーのTOTP構成を作成するための詳細。

ソースの表示

• configUrl(required): string
  TOTP構成URL
• deviceName: string
  ユーザーのデバイスの名前
• expiryTimeInMs: integer (int64)
  構成URLおよびPINの有効期限
• pin(required): string
  TOTP構成PIN番号

{
    "required":[
        "configUrl",
        "pin"
    ],
    "type":"object",
    "properties":{
        "configUrl":{
            "type":"string",
            "description":"The TOTP config URL"
        },
        "deviceName":{
            "type":"string",
            "description":"Name of the user's device"
        },
        "pin":{
            "type":"string",
            "description":"The TOTP config pin number"
        },
        "expiryTimeInMs":{
            "type":"integer",
            "description":"The expiration time of the config URL and pin",
            "format":"int64"
        }
    },
    "description":"Details for creating a totp config for a user."
}

400レスポンス

不正なリクエスト

401レスポンス

未認可

403レスポンス

TOTP構成を作成できませんでした

422レスポンス

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

500レスポンス

内部サーバー・エラー

503レスポンス

サービス使用不可

先頭に戻る

例

次の例は、時間ベースのワンタイム・パスワード(TOTP)登録URLを生成するサンプルのリクエストとレスポンスを示します。

JSON形式でTOTP登録URLを生成するcURLコマンド

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

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

configUrl": "oraclemobileauthenticator://settings?ServiceName::=JoeSmithDevice3&ServiceType::=SharedSecret&SharedSecretAuthServerType::=HTTPBasicAuthentication&LoginURL::=https://oaa.example.com:12345/oaa/rui/totpPreferences/v1?contextInfo=dGVzdHVzZXI0OmZpbmFuY2VhcHA0OjJjYmM5ZDczLWIyZDItNGI0ZC05YjZkLTkxNjFiMDkwYjg3NjpSYW5qYW5EZXZpY2Uz",
"deviceName": "JoeSmithDevice3",
"pin": "NTUzNDgy",
"expiryTimeInMs": 1696327720855
}

XML形式でTOTP登録URLを生成するcURLコマンド

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

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<CreateTotpConfigResponse>
	<configUrl>oraclemobileauthenticator://settings?ServiceName::=JoeSmithDevice3&ServiceType::=SharedSecret&SharedSecretAuthServerType::=HTTPBasicAuthentication&LoginURL::=https://oaa.example.com:12345/oaa/rui/totpPreferences/v1?contextInfo=dGVzdHVzZXI0OmZpbmFuY2VhcHA0OmY2ODI5N2M2LTY4ZDgtNDU5OC05NDc1LTAxNWRmZWExNTM2MzpSYW5qYW5EZXZpY2Uz</configUrl>
	<deviceName>JoeSmithDevice3</deviceName>
	<pin>ODE4ODM2</pin>
	<expiryTimeInMs>1696328061642</expiryTimeInMs>
</CreateTotpConfigResponse>

先頭に戻る