mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-09 12:27:47 +00:00
140 lines
4.0 KiB
YAML
140 lines
4.0 KiB
YAML
get:
|
|
tags:
|
|
- Transforms
|
|
summary: Transform by ID
|
|
description: >-
|
|
This API returns the transform specified by the given ID.
|
|
|
|
A token with transform read authority is required to call this API.
|
|
|
|
operationId: getTransform
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: ID of the transform to retrieve
|
|
required: true
|
|
style: simple
|
|
explode: false
|
|
example: 2cd78adghjkja34jh2b1hkjhasuecd
|
|
schema:
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: Transform with the given ID
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../schemas/Transform.yaml'
|
|
"400":
|
|
$ref: '../../v3/responses/400.yaml'
|
|
"401":
|
|
$ref: '../../v3/responses/401.yaml'
|
|
"403":
|
|
$ref: '../../v3/responses/403.yaml'
|
|
"404":
|
|
$ref: '../../v3/responses/404.yaml'
|
|
"429":
|
|
$ref: '../../v3/responses/429.yaml'
|
|
"500":
|
|
$ref: '../../v3/responses/500.yaml'
|
|
security:
|
|
- oauth2: [idn:transforms:read]
|
|
put:
|
|
tags:
|
|
- Transforms
|
|
summary: Update a transform
|
|
description: >-
|
|
Replaces the transform specified by the given ID with the transform provided in the request body. Only the
|
|
"attributes" field is mutable. Attempting to change other properties (ex. "name" and "type") will result in an error.
|
|
|
|
A token with transform write authority is required to call this API.
|
|
|
|
operationId: updateTransform
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: ID of the transform to update
|
|
required: true
|
|
style: simple
|
|
explode: false
|
|
schema:
|
|
type: string
|
|
example: 2cd78adghjkja34jh2b1hkjhasuecd
|
|
requestBody:
|
|
description: >-
|
|
The updated transform object (must include "name", "type", and "attributes" fields).
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../schemas/Transform.yaml'
|
|
example:
|
|
name: Timestamp To Date
|
|
type: dateFormat
|
|
attributes: { "inputFormat": "MMM-dd-yyyy, HH:mm:ss.SSS", "outputFormat": "yyyy/dd/MM" }
|
|
responses:
|
|
"200":
|
|
description: Indicates the transform was successfully updated and returns its new representation.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../schemas/Transform.yaml'
|
|
example:
|
|
id: 2cd78adghjkja34jh2b1hkjhasuecd
|
|
name: Timestamp To Date
|
|
type: dateFormat
|
|
attributes: { "inputFormat": "MMM-dd-yyyy, HH:mm:ss.SSS", "outputFormat": "yyyy/dd/MM" }
|
|
internal: false
|
|
"400":
|
|
$ref: '../../v3/responses/400.yaml'
|
|
"401":
|
|
$ref: '../../v3/responses/401.yaml'
|
|
"403":
|
|
$ref: '../../v3/responses/403.yaml'
|
|
"404":
|
|
$ref: '../../v3/responses/404.yaml'
|
|
"429":
|
|
$ref: '../../v3/responses/429.yaml'
|
|
"500":
|
|
$ref: '../../v3/responses/500.yaml'
|
|
security:
|
|
- oauth2: [idn:transforms:write]
|
|
delete:
|
|
tags:
|
|
- Transforms
|
|
summary: Delete a transform
|
|
description: >-
|
|
Deletes the transform specified by the given ID.
|
|
Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error.
|
|
If this occurs, you must first remove the transform from all mappings before deleting the transform.
|
|
|
|
A token with transform delete authority is required to call this API.
|
|
|
|
operationId: deleteTransform
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: ID of the transform to delete
|
|
required: true
|
|
style: simple
|
|
explode: false
|
|
schema:
|
|
type: string
|
|
example: 2cd78adghjkja34jh2b1hkjhasuecd
|
|
responses:
|
|
"204":
|
|
$ref: '../../v3/responses/204.yaml'
|
|
"400":
|
|
$ref: '../../v3/responses/400.yaml'
|
|
"401":
|
|
$ref: '../../v3/responses/401.yaml'
|
|
"403":
|
|
$ref: '../../v3/responses/403.yaml'
|
|
"404":
|
|
$ref: '../../v3/responses/404.yaml'
|
|
"429":
|
|
$ref: '../../v3/responses/429.yaml'
|
|
"500":
|
|
$ref: '../../v3/responses/500.yaml'
|
|
security:
|
|
- oauth2: [idn:transforms:delete]
|