Jump to

• Request
• Response
• Examples

Creates new template with given details for the entire system.

post

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

Creates a new template.

Request

Supported Media Types

• application/json

Path Parameters

• name(required): string
  Unique Name of the Template

Body ()

Template that needs to be created

Root Schema : Template

Type: object

Show Source

• defaultValue: string
  Default value to be used in case the template processing fails.
• description: string
  Details describing the intent of this template.
• dynamicParams: array dynamicParams
  To use dynamic parameters while defining valueTransformation and valueFiltering, they must be added here.
• transformFirst: boolean
  Default Value: false

  If set to true then valueTransformation will be applied before valueFiltering.
• valueFiltering: object ValueFiltering
• valueMapping(required): string
  We can specify the source for value of a template.
• valueTransformation: 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."
        }
    }
}

Nested Schema : dynamicParams

Type: array

To use dynamic parameters while defining valueTransformation and valueFiltering, they must be added here.

Show Source

• Array of: string

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

Nested Schema : ValueFiltering

Type: object

Show Source

• params: array params
  Parameters for the java method used in populateIf or populateIfNot tag.
• populateIf: string
  Returns claim value only if the result of this filter java method is true.
• populateIfNot: string
  Returns claim value only if the result of this filter java method is false.
• type: array type
  Type of the parameters.

{
    "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."
        }
    }
}

Nested Schema : valueTransformation

Type: array

Show Source

• Array of: object ValueTransformation

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

Nested Schema : params

Type: array

Parameters for the java method used in populateIf or populateIfNot tag.

Show Source

• Array of: string

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

Nested Schema : type

Type: array

Type of the parameters.

Show Source

• Array of: string

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

Nested Schema : ValueTransformation

Type: object

Show Source

• operation(required): string
  Java method name used as transformation operation.
• params: array params
  Parameters for the java method used in operation tag.
• type: array type
  Type of the parameters.

{
    "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."
        }
    }
}

Nested Schema : params

Type: array

Parameters for the java method used in operation tag.

Show Source

• Array of: string

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

Nested Schema : type

Type: array

Type of the parameters.

Show Source

• Array of: string

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : Template

Type: object

Show Source

• defaultValue: string
  Default value to be used in case the template processing fails.
• description: string
  Details describing the intent of this template.
• dynamicParams: array dynamicParams
  To use dynamic parameters while defining valueTransformation and valueFiltering, they must be added here.
• transformFirst: boolean
  Default Value: false

  If set to true then valueTransformation will be applied before valueFiltering.
• valueFiltering: object ValueFiltering
• valueMapping(required): string
  We can specify the source for value of a template.
• valueTransformation: 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."
        }
    }
}

Nested Schema : dynamicParams

Type: array

To use dynamic parameters while defining valueTransformation and valueFiltering, they must be added here.

Show Source

• Array of: string

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

Nested Schema : ValueFiltering

Type: object

Show Source

• params: array params
  Parameters for the java method used in populateIf or populateIfNot tag.
• populateIf: string
  Returns claim value only if the result of this filter java method is true.
• populateIfNot: string
  Returns claim value only if the result of this filter java method is false.
• type: array type
  Type of the parameters.

{
    "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."
        }
    }
}

Nested Schema : valueTransformation

Type: array

Show Source

• Array of: object ValueTransformation

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

Nested Schema : params

Type: array

Parameters for the java method used in populateIf or populateIfNot tag.

Show Source

• Array of: string

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

Nested Schema : type

Type: array

Type of the parameters.

Show Source

• Array of: string

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

Nested Schema : ValueTransformation

Type: object

Show Source

• operation(required): string
  Java method name used as transformation operation.
• params: array params
  Parameters for the java method used in operation tag.
• type: array type
  Type of the parameters.

{
    "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."
        }
    }
}

Nested Schema : params

Type: array

Parameters for the java method used in operation tag.

Show Source

• Array of: string

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

Nested Schema : type

Type: array

Type of the parameters.

Show Source

• Array of: string

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

422 Response

Template : already exists.

Body ()

Root Schema : Error

Type: object

Show Source

• error: string
  Error code
• error_description: string
  Error description

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

Back to Top

Examples

cURL Sample Request 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 Sample Request 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"
            ]
        }
    ]
}'

Back to Top