mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-09 20:37:47 +00:00
Automated commit by github action: 4949621425
This commit is contained in:
GitHub Action Bot
@@ -638,6 +638,7 @@ tags:
|
||||
|
||||
Well organized, mappped out connections between sources and IdentityNow are essential to achieving comprehensive identity access governance across all the source systems organizations need.
|
||||
Refer to [Managing Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) for more information about all the different things admins can do with sources once they are connected.
|
||||
- name: Tagged Objects
|
||||
- name: Transforms
|
||||
description: |
|
||||
The purpose of this API is to expose functionality for the manipulation of Transform objects.
|
||||
@@ -875,6 +876,16 @@ paths:
|
||||
$ref: "./v3/paths/source-entitlements-schema.yaml"
|
||||
/sources/{sourceId}/upload-connector-file:
|
||||
$ref: "./v3/paths/source-upload-connector-file.yaml"
|
||||
/tagged-objects:
|
||||
$ref: "./v3/paths/tagged-objects.yaml"
|
||||
/tagged-objects/{type}:
|
||||
$ref: "./v3/paths/tagged-objects-type.yaml"
|
||||
/tagged-objects/{type}/{id}:
|
||||
$ref: "./v3/paths/tagged-object.yaml"
|
||||
/tagged-objects/bulk-add:
|
||||
$ref: "./v3/paths/bulk-add-tagged-objects.yaml"
|
||||
/tagged-objects/bulk-remove:
|
||||
$ref: "./v3/paths/bulk-remove-tagged-objects.yaml"
|
||||
/transforms:
|
||||
$ref: "./v3/paths/transforms.yaml"
|
||||
/transforms/{id}:
|
||||
|
||||
37
static/api-specs/idn/v3/paths/bulk-add-tagged-objects.yaml
Normal file
37
static/api-specs/idn/v3/paths/bulk-add-tagged-objects.yaml
Normal file
@@ -0,0 +1,37 @@
|
||||
post:
|
||||
operationId: setTagsToManyObjects
|
||||
security:
|
||||
- oauth2: [ idn:tag:manage ]
|
||||
tags:
|
||||
- Tagged Objects
|
||||
summary: Tag Multiple Objects
|
||||
description: >-
|
||||
This API adds tags to multiple objects.
|
||||
|
||||
|
||||
A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN
|
||||
authority is required to call this API.
|
||||
requestBody:
|
||||
required: true
|
||||
description: Supported object types are ROLE, IDENTITY and SOD_POLICY.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../schemas/BulkTaggedObject.yaml'
|
||||
responses:
|
||||
'200':
|
||||
description: Request succeeded.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../schemas/BulkTaggedObject.yaml'
|
||||
'400':
|
||||
$ref: '../../v3/responses/400.yaml'
|
||||
'401':
|
||||
$ref: '../../v3/responses/401.yaml'
|
||||
'403':
|
||||
$ref: '../../v3/responses/403.yaml'
|
||||
'429':
|
||||
$ref: '../../v3/responses/429.yaml'
|
||||
'500':
|
||||
$ref: '../../v3/responses/500.yaml'
|
||||
@@ -0,0 +1,33 @@
|
||||
post:
|
||||
operationId: deleteTagsToManyObject
|
||||
security:
|
||||
- oauth2: [ idn:tag:manage ]
|
||||
tags:
|
||||
- Tagged Objects
|
||||
summary: Remove Tags from Multiple Objects
|
||||
description: >-
|
||||
This API removes tags from multiple objects.
|
||||
|
||||
|
||||
A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN
|
||||
authority is required to call this API.
|
||||
requestBody:
|
||||
description: Supported object types are ROLE, IDENTITY and SOD_POLICY.
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../schemas/BulkTaggedObject.yaml'
|
||||
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'
|
||||
'429':
|
||||
$ref: '../../v3/responses/429.yaml'
|
||||
'500':
|
||||
$ref: '../../v3/responses/500.yaml'
|
||||
137
static/api-specs/idn/v3/paths/tagged-object.yaml
Normal file
137
static/api-specs/idn/v3/paths/tagged-object.yaml
Normal file
@@ -0,0 +1,137 @@
|
||||
get:
|
||||
operationId: getTaggedObject
|
||||
security:
|
||||
- oauth2: [ idn:tag:read, idn:tag:manage ]
|
||||
tags:
|
||||
- Tagged Objects
|
||||
summary: Get Tagged Object
|
||||
description: >-
|
||||
This gets a tagged object for the specified type.
|
||||
parameters:
|
||||
- in: path
|
||||
name: type
|
||||
schema:
|
||||
type: string
|
||||
enum:
|
||||
- ROLE
|
||||
- IDENTITY
|
||||
- SOD_POLICY
|
||||
required: true
|
||||
description: The type of tagged object to retrieve.
|
||||
example: ROLE
|
||||
- in: path
|
||||
name: id
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: The ID of the object reference to retrieve.
|
||||
example: ef38f94347e94562b5bb8424a56397d8
|
||||
responses:
|
||||
'200':
|
||||
description: Tagged object by type and ID.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../schemas/TaggedObject.yaml'
|
||||
'400':
|
||||
$ref: '../../v3/responses/400.yaml'
|
||||
'401':
|
||||
$ref: '../../v3/responses/401.yaml'
|
||||
'403':
|
||||
$ref: '../../v3/responses/403.yaml'
|
||||
'429':
|
||||
$ref: '../../v3/responses/429.yaml'
|
||||
'500':
|
||||
$ref: '../../v3/responses/500.yaml'
|
||||
put:
|
||||
operationId: putTaggedObject
|
||||
security:
|
||||
- oauth2: [ idn:tag:manage ]
|
||||
tags:
|
||||
- Tagged Objects
|
||||
summary: Update Tagged Object
|
||||
description: >-
|
||||
This updates a tagged object for the specified type.
|
||||
parameters:
|
||||
- in: path
|
||||
name: type
|
||||
schema:
|
||||
type: string
|
||||
enum:
|
||||
- ROLE
|
||||
- IDENTITY
|
||||
- SOD_POLICY
|
||||
required: true
|
||||
description: The type of tagged object to update.
|
||||
example: ROLE
|
||||
- in: path
|
||||
name: id
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: The ID of the object reference to update.
|
||||
example: ef38f94347e94562b5bb8424a56397d8
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../schemas/TaggedObject.yaml'
|
||||
responses:
|
||||
'200':
|
||||
description: Tagged object by type and ID.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../schemas/TaggedObject.yaml'
|
||||
'400':
|
||||
$ref: '../../v3/responses/400.yaml'
|
||||
'401':
|
||||
$ref: '../../v3/responses/401.yaml'
|
||||
'403':
|
||||
$ref: '../../v3/responses/403.yaml'
|
||||
'429':
|
||||
$ref: '../../v3/responses/429.yaml'
|
||||
'500':
|
||||
$ref: '../../v3/responses/500.yaml'
|
||||
delete:
|
||||
operationId: deleteTaggedObject
|
||||
security:
|
||||
- oauth2: [ idn:tag:manage ]
|
||||
tags:
|
||||
- Tagged Objects
|
||||
summary: Delete Tagged Object
|
||||
description: >-
|
||||
This deletes a tagged object for the specified type.
|
||||
parameters:
|
||||
- in: path
|
||||
name: type
|
||||
schema:
|
||||
type: string
|
||||
enum:
|
||||
- ROLE
|
||||
- IDENTITY
|
||||
- SOD_POLICY
|
||||
required: true
|
||||
description: The type of tagged object to delete.
|
||||
example: ROLE
|
||||
- in: path
|
||||
name: id
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: The ID of the object reference to delete.
|
||||
example: ef38f94347e94562b5bb8424a56397d8
|
||||
responses:
|
||||
'204':
|
||||
description: No content.
|
||||
'400':
|
||||
$ref: '../../v3/responses/400.yaml'
|
||||
'401':
|
||||
$ref: '../../v3/responses/401.yaml'
|
||||
'403':
|
||||
$ref: '../../v3/responses/403.yaml'
|
||||
'429':
|
||||
$ref: '../../v3/responses/429.yaml'
|
||||
'500':
|
||||
$ref: '../../v3/responses/500.yaml'
|
||||
63
static/api-specs/idn/v3/paths/tagged-objects-type.yaml
Normal file
63
static/api-specs/idn/v3/paths/tagged-objects-type.yaml
Normal file
@@ -0,0 +1,63 @@
|
||||
get:
|
||||
operationId: listTaggedObjectsByType
|
||||
security:
|
||||
- oauth2: [ idn:tag:read, idn:tag:manage ]
|
||||
tags:
|
||||
- Tagged Objects
|
||||
summary: List Tagged Objects
|
||||
description: >-
|
||||
This API returns a list of all tagged objects by type.
|
||||
|
||||
|
||||
Any authenticated token may be used to call this API.
|
||||
parameters:
|
||||
- in: path
|
||||
name: type
|
||||
schema:
|
||||
type: string
|
||||
enum:
|
||||
- ROLE
|
||||
- IDENTITY
|
||||
- SOD_POLICY
|
||||
required: true
|
||||
description: The type of tagged object to retrieve.
|
||||
example: ROLE
|
||||
- $ref: '../../v3/parameters/limit.yaml'
|
||||
- $ref: '../../v3/parameters/offset.yaml'
|
||||
- $ref: '../../v3/parameters/count.yaml'
|
||||
- in: query
|
||||
name: filters
|
||||
schema:
|
||||
type: string
|
||||
description: >-
|
||||
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
||||
|
||||
|
||||
Filtering is supported for the following fields and operators:
|
||||
|
||||
|
||||
**objectRef.id**: *eq*
|
||||
|
||||
|
||||
**objectRef.type**: *eq*
|
||||
example: objectRef.id eq "2c91808568c529c60168cca6f90c1313"
|
||||
required: false
|
||||
responses:
|
||||
'200':
|
||||
description: List of all tagged objects for specified type.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '../schemas/TaggedObject.yaml'
|
||||
'400':
|
||||
$ref: '../../v3/responses/400.yaml'
|
||||
'401':
|
||||
$ref: '../../v3/responses/401.yaml'
|
||||
'403':
|
||||
$ref: '../../v3/responses/403.yaml'
|
||||
'429':
|
||||
$ref: '../../v3/responses/429.yaml'
|
||||
'500':
|
||||
$ref: '../../v3/responses/500.yaml'
|
||||
92
static/api-specs/idn/v3/paths/tagged-objects.yaml
Normal file
92
static/api-specs/idn/v3/paths/tagged-objects.yaml
Normal file
@@ -0,0 +1,92 @@
|
||||
get:
|
||||
operationId: listTaggedObjects
|
||||
security:
|
||||
- oauth2: [ idn:tag:read, idn:tag:manage ]
|
||||
tags:
|
||||
- Tagged Objects
|
||||
summary: List Tagged Objects
|
||||
description: >-
|
||||
This API returns a list of all tagged objects.
|
||||
|
||||
|
||||
Any authenticated token may be used to call this API.
|
||||
parameters:
|
||||
- $ref: '../../v3/parameters/limit.yaml'
|
||||
- $ref: '../../v3/parameters/offset.yaml'
|
||||
- $ref: '../../v3/parameters/count.yaml'
|
||||
- in: query
|
||||
name: filters
|
||||
schema:
|
||||
type: string
|
||||
description: >-
|
||||
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
||||
|
||||
|
||||
Filtering is supported for the following fields and operators:
|
||||
|
||||
|
||||
**objectRef.id**: *eq, in*
|
||||
|
||||
|
||||
**objectRef.type**: *eq, in*
|
||||
|
||||
|
||||
**tagName**: *eq, in*
|
||||
example: tagName eq "BU_FINANCE"
|
||||
required: false
|
||||
responses:
|
||||
'200':
|
||||
description: List of all tagged objects.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '../schemas/TaggedObject.yaml'
|
||||
'400':
|
||||
$ref: '../../v3/responses/400.yaml'
|
||||
'401':
|
||||
$ref: '../../v3/responses/401.yaml'
|
||||
'403':
|
||||
$ref: '../../v3/responses/403.yaml'
|
||||
'429':
|
||||
$ref: '../../v3/responses/429.yaml'
|
||||
'500':
|
||||
$ref: '../../v3/responses/500.yaml'
|
||||
post:
|
||||
operationId: setTagToObject
|
||||
security:
|
||||
- oauth2: [ idn:tag:manage ]
|
||||
tags:
|
||||
- Tagged Objects
|
||||
summary: Add Tag to Object
|
||||
description: >-
|
||||
This adds a tag to an object.
|
||||
|
||||
|
||||
Any authenticated token may be used to call this API.
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../schemas/TaggedObject.yaml'
|
||||
responses:
|
||||
'200':
|
||||
description: Request succeeded.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '../schemas/TaggedObject.yaml'
|
||||
'201':
|
||||
description: Created.
|
||||
'400':
|
||||
$ref: '../../v3/responses/400.yaml'
|
||||
'401':
|
||||
$ref: '../../v3/responses/401.yaml'
|
||||
'403':
|
||||
$ref: '../../v3/responses/403.yaml'
|
||||
'429':
|
||||
$ref: '../../v3/responses/429.yaml'
|
||||
'500':
|
||||
$ref: '../../v3/responses/500.yaml'
|
||||
24
static/api-specs/idn/v3/schemas/BulkTaggedObject.yaml
Normal file
24
static/api-specs/idn/v3/schemas/BulkTaggedObject.yaml
Normal file
@@ -0,0 +1,24 @@
|
||||
type: object
|
||||
properties:
|
||||
objectRefs:
|
||||
type: array
|
||||
items:
|
||||
$ref: '../../v3/schemas/TaggedObjectDto.yaml'
|
||||
tags:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
description: Label to be applied to an Object
|
||||
example: [ "BU_FINANCE", "PCI" ]
|
||||
operation:
|
||||
type: string
|
||||
enum:
|
||||
- APPEND
|
||||
- MERGE
|
||||
default: APPEND
|
||||
description: >-
|
||||
If APPEND, tags are appended to the list of tags for the object. A 400 error is returned if this would add duplicate tags to the object.
|
||||
|
||||
|
||||
If MERGE, tags are merged with the existing tags. Duplicate tags are silently ignored.
|
||||
example: MERGE
|
||||
10
static/api-specs/idn/v3/schemas/TaggedObject.yaml
Normal file
10
static/api-specs/idn/v3/schemas/TaggedObject.yaml
Normal file
@@ -0,0 +1,10 @@
|
||||
type: object
|
||||
properties:
|
||||
objectRef:
|
||||
$ref: '../../v3/schemas/TaggedObjectDto.yaml'
|
||||
tags:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
description: Labels to be applied to an Object
|
||||
example: ["BU_FINANCE", "PCI"]
|
||||
14
static/api-specs/idn/v3/schemas/TaggedObjectDto.yaml
Normal file
14
static/api-specs/idn/v3/schemas/TaggedObjectDto.yaml
Normal file
@@ -0,0 +1,14 @@
|
||||
type: object
|
||||
properties:
|
||||
type:
|
||||
$ref: '../../v3/schemas/DtoType.yaml'
|
||||
description: DTO type
|
||||
id:
|
||||
type: string
|
||||
description: ID of the object to which this reference applies
|
||||
example: 2c91808568c529c60168cca6f90c1313
|
||||
name:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Human-readable display name of the object to which this reference applies
|
||||
example: William Wilson
|
||||
Reference in New Issue
Block a user