ジャンプ先

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

アイデンティティ・ドメインの新しい信頼アーティファクトの追加

投稿

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

リクエスト

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

• application/json
• application/xml

本文()

アイデンティティ・ドメインの作成する必要がある信頼アーティファクト

ルート・スキーマ: IDDomainTrustArtifact

型: object

ソースを表示

• identityDomainName: string
  信頼アーティファクトをインポートしているアイデンティティ・ドメインの名前
• trustArtifacts(optional): array trustArtifacts

{
    "type":"object",
    "required":[
        "identityDomainName"
    ],
    "properties":{
        "identityDomainName":{
            "type":"string",
            "description":"Name of the Identity Domain under which the trust artifacts are being imported"
        },
        "trustArtifacts":{
            "type":"array",
            "xml":{
                "name":"trustArtifacts",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/TrustArtifactSettings"
            }
        }
    }
}

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

型: array

ソースを表示

• 配列: オブジェクト TrustArtifactSettings
  アイデンティティ・ドメインの追加する信頼アーティファクト

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

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

型: object

アイデンティティ・ドメインの追加する信頼アーティファクト

ソースを表示

• artifactIdentifer: string
  アイデンティティ・ドメインのインポートされる信頼アーティファクトのキー識別子
• artifactValue: string
  Base64でエンコードされた公開証明書の値

{
    "type":"object",
    "description":"Trust artifacts added under an identity domain",
    "required":[
        "artifactIdentifer",
        "artifactValue"
    ],
    "properties":{
        "artifactIdentifer":{
            "type":"string",
            "description":"Key Identifier of the Trust Artifact that is imported under the Identity Domain"
        },
        "artifactValue":{
            "type":"string",
            "description":"Base64 encoded public certificate value"
        }
    }
}

先頭に戻る

レスポンス

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

• application/json

200 レスポンス

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

本文()

ルート・スキーマ: IdentityDomainResponse

型: object

ソースを表示

• consentPageURL(optional): string
  カスタマイズされた同意ページの完全修飾URL
• description(optional): string
• errorPageURL(optional): string
  カスタマイズされたエラー・ページの完全修飾URL
• identityProvider(optional): string
  認証を完了しているアイデンティティ・ストアの名前
• name: string
  アイデンティティ・ドメインの名前
• tokenSettings(optional): array tokenSetting
• trustStoreIdentifier(optional): array trustStoreIdentifier

{
    "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"
        },
        "trustStoreIdentifier":{
            "type":"array",
            "xml":{
                "name":"trustStoreIdentifier",
                "wrapped":true
            },
            "items":{
                "type":"string"
            }
        },
        "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"
    }
}

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

型: array

ソースを表示

• 配列: 文字列

{
    "type":"array",
    "xml":{
        "name":"trustStoreIdentifier",
        "wrapped":true
    },
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: 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"の変更に失敗しました

先頭に戻る