ジャンプ先

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

システム全体の詳細を指定して新しいテンプレートを作成します。

投稿

/oam/services/rest/ssa/api/v1/template/{name}

新規テンプレートを作成します。

リクエスト

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

• application/json

パス・パラメータ

• name: string
  テンプレートの一意の名前

本文()

作成する必要があるテンプレート

ルート・スキーマ: Template

型: object

ソースを表示

• defaultValue(optional): string
  テンプレート処理に失敗した場合に使用されるデフォルト値。
• description(optional): string
  このテンプレートの目的を説明する詳細。
• dynamicParams(optional): array dynamicParams
  valueTransformationおよびvalueFilteringの定義中に動的パラメータを使用するには、ここで追加する必要があります。
• transformFirst(optional): boolean
  デフォルト値: false

  trueに設定すると、valueFilteringの前にvalueTransformationが適用されます。
• valueFiltering(optional): object ValueFiltering
• valueMapping: string
  テンプレートの値のソースを指定できます。
• valueTransformation(optional): array valueTransformation

{
    "type":"object",
    "required":[
        "valueMapping"
    ],
    "properties":{
        "description":{
            "type":"string",
            "description":"Details describing the intent of this template."
        },
        "defaultValue":{
            "type":"string",
            "description":"Default value to be used in case the template processing fails."
        },
        "valueMapping":{
            "type":"string",
            "description":"We can specify the source for value of a template."
        },
        "valueFiltering":{
            "$ref":"#/definitions/ValueFiltering"
        },
        "valueTransformation":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ValueTransformation"
            }
        },
        "transformFirst":{
            "type":"boolean",
            "description":"If set to true then valueTransformation will be applied before valueFiltering.",
            "default":false
        },
        "dynamicParams":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"To use dynamic parameters while defining valueTransformation and valueFiltering, they must be added here."
        }
    }
}

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

型: array

valueTransformationおよびvalueFilteringの定義中に動的パラメータを使用するには、ここで追加する必要があります。

ソースを表示

• 配列: 文字列

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"To use dynamic parameters while defining valueTransformation and valueFiltering, they must be added here."
}

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

型: object

ソースを表示

• params(optional): array params
  populateIfまたはpopulateIfNotタグで使用されるjavaメソッドのパラメータ。
• populateIf(optional): string
  このフィルタjavaメソッドの結果がtrueの場合にのみ、クレーム値を返します。
• populateIfNot(optional): string
  このフィルタjavaメソッドの結果がfalseの場合にのみ、クレーム値を返します。
• type(optional): array type
  パラメータのタイプ。

{
    "type":"object",
    "properties":{
        "populateIf":{
            "type":"string",
            "description":"Returns claim value only if the result of this filter java method is true."
        },
        "populateIfNot":{
            "type":"string",
            "description":"Returns claim value only if the result of this filter java method is false."
        },
        "params":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"Parameters for the java method used in populateIf or populateIfNot tag."
        },
        "type":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"Type of the parameters."
        }
    }
}

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

型: array

ソースを表示

• 配列: オブジェクト ValueTransformation

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ValueTransformation"
    }
}

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

型: array

populateIfまたはpopulateIfNotタグで使用されるjavaメソッドのパラメータ。

ソースを表示

• 配列: 文字列

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"Parameters for the java method used in populateIf or populateIfNot tag."
}

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

型: array

パラメータのタイプ。

ソースを表示

• 配列: 文字列

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"Type of the parameters."
}

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

型: object

ソースを表示

• operation: string
  変換操作として使用されるJavaメソッド名。
• params(optional): array params
  操作タグで使用されるjavaメソッドのパラメータ。
• type(optional): array type
  パラメータのタイプ。

{
    "type":"object",
    "required":[
        "operation"
    ],
    "properties":{
        "operation":{
            "type":"string",
            "description":"Java method name used as transformation operation."
        },
        "params":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"Parameters for the java method used in operation tag."
        },
        "type":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"Type of the parameters."
        }
    }
}

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

型: array

操作タグで使用されるjavaメソッドのパラメータ。

ソースを表示

• 配列: 文字列

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"Parameters for the java method used in operation tag."
}

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

型: array

パラメータのタイプ。

ソースを表示

• 配列: 文字列

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"Type of the parameters."
}

先頭に戻る

レスポンス

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

• application/json

200 レスポンス

OK。

本文()

ルート・スキーマ: Template

型: object

ソースを表示

• defaultValue(optional): string
  テンプレート処理に失敗した場合に使用されるデフォルト値。
• description(optional): string
  このテンプレートの目的を説明する詳細。
• dynamicParams(optional): array dynamicParams
  valueTransformationおよびvalueFilteringの定義中に動的パラメータを使用するには、ここで追加する必要があります。
• transformFirst(optional): boolean
  デフォルト値: false

  trueに設定すると、valueFilteringの前にvalueTransformationが適用されます。
• valueFiltering(optional): object ValueFiltering
• valueMapping: string
  テンプレートの値のソースを指定できます。
• valueTransformation(optional): array valueTransformation

{
    "type":"object",
    "required":[
        "valueMapping"
    ],
    "properties":{
        "description":{
            "type":"string",
            "description":"Details describing the intent of this template."
        },
        "defaultValue":{
            "type":"string",
            "description":"Default value to be used in case the template processing fails."
        },
        "valueMapping":{
            "type":"string",
            "description":"We can specify the source for value of a template."
        },
        "valueFiltering":{
            "$ref":"#/definitions/ValueFiltering"
        },
        "valueTransformation":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ValueTransformation"
            }
        },
        "transformFirst":{
            "type":"boolean",
            "description":"If set to true then valueTransformation will be applied before valueFiltering.",
            "default":false
        },
        "dynamicParams":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"To use dynamic parameters while defining valueTransformation and valueFiltering, they must be added here."
        }
    }
}

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

型: array

valueTransformationおよびvalueFilteringの定義中に動的パラメータを使用するには、ここで追加する必要があります。

ソースを表示

• 配列: 文字列

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"To use dynamic parameters while defining valueTransformation and valueFiltering, they must be added here."
}

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

型: object

ソースを表示

• params(optional): array params
  populateIfまたはpopulateIfNotタグで使用されるjavaメソッドのパラメータ。
• populateIf(optional): string
  このフィルタjavaメソッドの結果がtrueの場合にのみ、クレーム値を返します。
• populateIfNot(optional): string
  このフィルタjavaメソッドの結果がfalseの場合にのみ、クレーム値を返します。
• type(optional): array type
  パラメータのタイプ。

{
    "type":"object",
    "properties":{
        "populateIf":{
            "type":"string",
            "description":"Returns claim value only if the result of this filter java method is true."
        },
        "populateIfNot":{
            "type":"string",
            "description":"Returns claim value only if the result of this filter java method is false."
        },
        "params":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"Parameters for the java method used in populateIf or populateIfNot tag."
        },
        "type":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"Type of the parameters."
        }
    }
}

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

型: array

ソースを表示

• 配列: オブジェクト ValueTransformation

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ValueTransformation"
    }
}

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

型: array

populateIfまたはpopulateIfNotタグで使用されるjavaメソッドのパラメータ。

ソースを表示

• 配列: 文字列

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"Parameters for the java method used in populateIf or populateIfNot tag."
}

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

型: array

パラメータのタイプ。

ソースを表示

• 配列: 文字列

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"Type of the parameters."
}

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

型: object

ソースを表示

• operation: string
  変換操作として使用されるJavaメソッド名。
• params(optional): array params
  操作タグで使用されるjavaメソッドのパラメータ。
• type(optional): array type
  パラメータのタイプ。

{
    "type":"object",
    "required":[
        "operation"
    ],
    "properties":{
        "operation":{
            "type":"string",
            "description":"Java method name used as transformation operation."
        },
        "params":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"Parameters for the java method used in operation tag."
        },
        "type":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"Type of the parameters."
        }
    }
}

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

型: array

操作タグで使用されるjavaメソッドのパラメータ。

ソースを表示

• 配列: 文字列

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"Parameters for the java method used in operation tag."
}

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

型: array

パラメータのタイプ。

ソースを表示

• 配列: 文字列

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"Type of the parameters."
}

422 レスポンス

テンプレート:はすでに存在します。

本文()

ルート・スキーマ: Error

型: object

ソースを表示

• error(optional): string
  エラー・コード
• error_description(optional): string
  エラーの説明

{
    "type":"object",
    "properties":{
        "error":{
            "type":"string",
            "description":"Error code"
        },
        "error_description":{
            "type":"string",
            "description":"Error description"
        }
    }
}

先頭に戻る

例

cURLサンプル・リクエスト1

curl -X POST https://<admin-host>:<admin-port>/oam/services/rest/ssa/api/v1/template/website \
  -H 'Accept: application/json' \
  -H 'Authorization: Basic dGVzdDp0ZXN0=' \
  -H 'Content-Type: application/json' \
  -H 'cache-control: no-cache' \
  -d '{
    "valueMapping": "$user.attr.website",
    "valueFiltering": {
        "populateIf": "startsWith",
        "params": [
            "https"
        ]
    },
    "valueTransformation": [
        {
            "operation": "toLowerCase"
        }
    ]
}'

cURLサンプル・リクエスト2

curl -X POST https://<admin-host>:<admin-port>/oam/services/rest/ssa/api/v1/template/customemail \
  -H 'Accept: application/json' \
  -H 'Authorization: Basic dGVzdDp0ZXN0=' \
  -H 'Content-Type: application/json' \
  -H 'cache-control: no-cache' \
  -d '{
    "dynamicParams": [
        "$user.attr.familyName",
        "$user.attr.custom2"
    ],
    "valueMapping": "$user.attr.givenName",
    "valueTransformation": [
        {
            "operation": "join",
            "params": [
                ".",
                "$user.attr.givenName",
                "$user.attr.familyName"
            ],
            "type": [
                "CharSequence",
                "CharSequence[]"
            ]
        },
        {
            "operation": "concat",
            "params": [
                "@"
            ]
        },
        {
            "operation": "concat",
            "params": [
                "$user.attr.custom2"
            ]
        },
        {
            "operation": "concat",
            "params": [
                ".com"
            ]
        }
    ]
}'

先頭に戻る