ジャンプ先

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

登録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
  ユーザーのユーザー名。

{
    "type":"object",
    "description":"Details for creating a TOTP registration URL.",
    "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":"Immutable ID of the user in the external systems. If this is present, then it takes precedence over userId + groupId combination."
        }
    }
}

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

ルート・スキーマ: schema

型: object

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

ソースの表示

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

{
    "type":"object",
    "description":"Details for creating a TOTP registration URL.",
    "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":"Immutable ID of the user in the external systems. If this is present, then it takes precedence over userId + groupId combination."
        }
    }
}

先頭に戻る

レスポンス

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

• 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番号

{
    "type":"object",
    "description":"Details for creating a totp config for a user.",
    "required":[
        "configUrl",
        "pin"
    ],
    "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",
            "format":"int64",
            "description":"The expiration time of the config URL and pin"
        }
    }
}

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

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

{
    "configUrl": "oraclemobileauthenticator://settings?ServiceName::=JoeSmithDevice3&ServiceType::=SharedSecret&SharedSecretAuthServerType::=HTTPBasicAuthentication&LoginURL::=https://oke-c4wgzrymu2d-nqfrtzofgqa-so4pjz7ycha-2.subnet2.idmociclou1iad.oraclevcn.com:31993/oaa/rui/totpPreferences/v1?contextInfo=dXNlcjE6ZmluYW5jZWFwcDoyMmEyOTA3MS0xNmYyLTRiNjktYTk0Yy03M2JlNjcyZTM0ZWI6YTlkMzY1OTUtMGUwNC00NWY0LTgyZDItNWJhMWVlMDIwYzkxOkpvZVNtaXRoRGV2aWNlMw==",
    "deviceName": "JoeSmithDevice3",
    "pin": "Mjg2ODkz",
    "expiryTimeInMs": 1741387998948
}

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

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<CreateTotpConfigResponse>
    <configUrl>oraclemobileauthenticator://settings?ServiceName::=JoeSmithDevice3&amp;ServiceType::=SharedSecret&amp;SharedSecretAuthServerType::=HTTPBasicAuthentication&amp;LoginURL::=https://oke-c4wgzrymu2d-nqfrtzofgqa-so4pjz7ycha-2.subnet2.idmociclou1iad.oraclevcn.com:31993/oaa/rui/totpPreferences/v1?contextInfo=dXNlcjE6ZmluYW5jZWFwcDoyMmEyOTA3MS0xNmYyLTRiNjktYTk0Yy03M2JlNjcyZTM0ZWI6NGViNTNlYjktYzFjZS00ZTBhLWI3MjktNWRjYzMwYmM1MTNhOkpvZVNtaXRoRGV2aWNlMw==</configUrl>
    <deviceName>JoeSmithDevice3</deviceName>
    <pin>MjY3Njcy</pin>
    <expiryTimeInMs>1741388137764</expiryTimeInMs>
</CreateTotpConfigResponse>

先頭に戻る