ジャンプ先

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

新しいOAuthアイデンティティ・ドメインの追加

投稿

/oam/services/rest/ssa/api/v1/oauthpolicyadmin/oauthidentitydomain

リクエスト

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

• application/json
• application/xml

本文()

作成する必要があるアイデンティティ・ドメイン

ルート・スキーマ: IdentityDomain

型: object

ソースを表示

• consentPageURL(optional): string
  カスタマイズされた同意ページの完全修飾URL
• customAttrs(optional): string
  TOTPの暗号化された秘密キーを格納するためのIDStoreのユーザーの属性
• description(optional): string
• errorPageURL(optional): string
  カスタマイズされたエラー・ページの完全修飾URL
• identityProvider(optional): string
  認証を完了しているアイデンティティ・ストアの名前
• name: string
  アイデンティティ・ドメインの名前
• tokenSettings(optional): array tokenSetting

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the Identity Domain"
        },
        "consentPageURL":{
            "type":"string",
            "description":"Fully qualified URL of the customized consent page"
        },
        "errorPageURL":{
            "type":"string",
            "description":"Fully qualified URL of the customized error page"
        },
        "identityProvider":{
            "type":"string",
            "description":"Name of the identity store against which authentication is completed"
        },
        "description":{
            "type":"string"
        },
        "customAttrs":{
            "type":"string",
            "description":"Attribute of user in IDStore to store the encrypted secretkey for TOTP"
        },
        "tokenSettings":{
            "type":"array",
            "xml":{
                "name":"tokenSetting",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/TokenSettings"
            }
        }
    }
}

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

型: array

ソースを表示

• 配列: オブジェクト TokenSettings

{
    "type":"array",
    "xml":{
        "name":"tokenSetting",
        "wrapped":true
    },
    "items":{
        "$ref":"#/definitions/TokenSettings"
    }
}

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

型: object

ソースを表示

• lifeCycleEnabled(optional): boolean
  デフォルト値: false
• refreshTokenEnabled: boolean
  デフォルト値: false
• refreshTokenExpiry: integer(int64)
• refreshTokenLifeCycleEnabled(optional): boolean
  デフォルト値: false
• tokenExpiry: integer(int64)
• tokenType: string
  指定可能な値: [ "ACCESS_TOKEN", "AUTHZ_CODE", "SSO_LINK_TOKEN" ]

  トークンのタイプ

{
    "type":"object",
    "required":[
        "refreshTokenEnabled",
        "refreshTokenExpiry",
        "tokenType",
        "tokenExpiry"
    ],
    "properties":{
        "refreshTokenEnabled":{
            "type":"boolean",
            "default":false
        },
        "refreshTokenLifeCycleEnabled":{
            "type":"boolean",
            "default":false
        },
        "refreshTokenExpiry":{
            "type":"integer",
            "format":"int64"
        },
        "lifeCycleEnabled":{
            "type":"boolean",
            "default":false
        },
        "tokenType":{
            "type":"string",
            "description":"Type of the token",
            "enum":[
                "ACCESS_TOKEN",
                "AUTHZ_CODE",
                "SSO_LINK_TOKEN"
            ]
        },
        "tokenExpiry":{
            "type":"integer",
            "format":"int64"
        }
    }
}

先頭に戻る

レスポンス

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

• application/json

200 レスポンス

エンティティ - OAuthIdentityDomain、詳細を正常に作成しました

本文()

ルート・スキーマ: IdentityDomain

型: object

ソースを表示

• consentPageURL(optional): string
  カスタマイズされた同意ページの完全修飾URL
• customAttrs(optional): string
  TOTPの暗号化された秘密キーを格納するためのIDStoreのユーザーの属性
• description(optional): string
• errorPageURL(optional): string
  カスタマイズされたエラー・ページの完全修飾URL
• identityProvider(optional): string
  認証を完了しているアイデンティティ・ストアの名前
• name: string
  アイデンティティ・ドメインの名前
• tokenSettings(optional): array tokenSetting

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the Identity Domain"
        },
        "consentPageURL":{
            "type":"string",
            "description":"Fully qualified URL of the customized consent page"
        },
        "errorPageURL":{
            "type":"string",
            "description":"Fully qualified URL of the customized error page"
        },
        "identityProvider":{
            "type":"string",
            "description":"Name of the identity store against which authentication is completed"
        },
        "description":{
            "type":"string"
        },
        "customAttrs":{
            "type":"string",
            "description":"Attribute of user in IDStore to store the encrypted secretkey for TOTP"
        },
        "tokenSettings":{
            "type":"array",
            "xml":{
                "name":"tokenSetting",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/TokenSettings"
            }
        }
    }
}

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

型: array

ソースを表示

• 配列: オブジェクト TokenSettings

{
    "type":"array",
    "xml":{
        "name":"tokenSetting",
        "wrapped":true
    },
    "items":{
        "$ref":"#/definitions/TokenSettings"
    }
}

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

型: object

ソースを表示

• lifeCycleEnabled(optional): boolean
  デフォルト値: false
• refreshTokenEnabled: boolean
  デフォルト値: false
• refreshTokenExpiry: integer(int64)
• refreshTokenLifeCycleEnabled(optional): boolean
  デフォルト値: false
• tokenExpiry: integer(int64)
• tokenType: string
  指定可能な値: [ "ACCESS_TOKEN", "AUTHZ_CODE", "SSO_LINK_TOKEN" ]

  トークンのタイプ

{
    "type":"object",
    "required":[
        "refreshTokenEnabled",
        "refreshTokenExpiry",
        "tokenType",
        "tokenExpiry"
    ],
    "properties":{
        "refreshTokenEnabled":{
            "type":"boolean",
            "default":false
        },
        "refreshTokenLifeCycleEnabled":{
            "type":"boolean",
            "default":false
        },
        "refreshTokenExpiry":{
            "type":"integer",
            "format":"int64"
        },
        "lifeCycleEnabled":{
            "type":"boolean",
            "default":false
        },
        "tokenType":{
            "type":"string",
            "description":"Type of the token",
            "enum":[
                "ACCESS_TOKEN",
                "AUTHZ_CODE",
                "SSO_LINK_TOKEN"
            ]
        },
        "tokenExpiry":{
            "type":"integer",
            "format":"int64"
        }
    }
}

422 レスポンス

OAuthエンティティ"IdentityDomain" - 名前"NameofIdentityDomain"の作成に失敗しました

先頭に戻る

例

アイデンティティ・ドメインを作成する2つの方法があります

• 簡易: このモードでは、作成するIdentityDomainの名前および説明のみが使用されます。残りの値はデフォルトが設定されます。

• 詳細: このモードでは、特定の値を異なるパラメータに付与できます。

cURLの例

この例は、簡易モードのアイデンティティ・ドメインを作成するサーバーに対するサンプル・リクエストを示します。

curl -i -H 'Content-Type: application/json' -H 'Authorization:Basic d2VibG9naWM6V2VsY29tZTE=' 
--request POST http:<Servername>:<Port>/oam/services/rest/ssa/api/v1/oauthpolicyadmin/oauthidentitydomain -d 
'{"name":"TestDomain","description":"Test Domain"}' 

cURLの例

この例は、詳細モードのアイデンティティ・ドメインを作成するサーバーに対するサンプル・リクエストを示します。

curl -i -H 'Content-Type: application/json' -H 'Authorization:Basic d2VibG9naWM6V2VsY29tZTE='
--request POST http:<Servername>:<Port>/oam/services/rest/ssa/api/v1/oauthpolicyadmin/oauthidentitydomain -d 
'{"name":"TestDomain","identityProvider":"UserIdentityStore1","description":"TestDomain","tokenSettings":[{"tokenType":"ACCESS_TOKEN","tokenExpiry":3600,"lifeCycleEnabled":false,"refreshTokenEnabled":false,"refreshTokenExpiry":86400,"refreshTokenLifeCycleEnabled":false}, {"tokenType":"AUTHZ_CODE","tokenExpiry":3600,
"lifeCycleEnabled":false,"refreshTokenEnabled":false,"refreshTokenExpiry":86400,"refreshTokenLifeCycleEnabled":false}, {"tokenType":"SSO_LINK_TOKEN","tokenExpiry":3600,"lifeCycleEnabled":false,"refreshTokenEnabled":false,"refreshTokenExpiry":86400,"refreshTokenLifeCycleEnabled":false}],"errorPageURL":"/oam/pages/error.jsp",
"consentPageURL":"/oam/pages/consent.jsp","customAttrs":"{\"domainCertValidityInDays\":\"30\", \"consentExpiryTimeInMinutes\":\"10\"}"}
'

レスポンス本文の例

次の例は、JSON形式の詳細モードのアイデンティティ・ドメインを作成するレスポンス本文のコンテンツを示します。

HTTP/1.1 200 OK
Date: Fri, 28 Jul 2017 13:01:41 GMT
Content-Length: 860
Content-Type: text/plain
X-ORACLE-DMS-ECID: 78d30c19-07b6-4ac2-a39b-f1cbd8182ebb-000003fd
X-ORACLE-DMS-RID: 0
Set-Cookie: JSESSIONID=_oGJSc7Vt2vIWLNQ_uwYCZz151JqOXewJRIkyvstnnio8WsNborT!-1875566563; path=/; HttpOnly

Sucessfully created entity - OAuthIdentityDomain, detail - OAuth Identity Domain :: Name - TestDomain, Id - 0b5f3fd731e44ae09c5b8bd1f4cfc355, Description - TestDomain, TrustStore Identifiers - [TestDomain], Identity Provider - UserIdentityStore1, TokenSettings - [{"tokenType":"ACCESS_TOKEN","tokenExpiry":3600,
"lifeCycleEnabled":false,"refreshTokenEnabled":false,"refreshTokenExpiry":86400,"refreshTokenLifeCycleEnabled":false}, {"tokenType":"AUTHZ_CODE","tokenExpiry":3600,"lifeCycleEnabled":false,"refreshTokenEnabled":false,"refreshTokenExpiry":86400,"refreshTokenLifeCycleEnabled":false}, {"tokenType":"SSO_LINK_TOKEN",
"tokenExpiry":3600,"lifeCycleEnabled":false,"refreshTokenEnabled":false,"refreshTokenExpiry":86400,"refreshTokenLifeCycleEnabled":false}], ConsentPageURL - /oam/pages/consent.jsp, ErrorPageURL - /oam/pages/error.jsp, CustomAttrs - {"domainCertValidityInDays":"30", "consentExpiryTimeInMinutes":"10"}

先頭に戻る