mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-09 12:27:47 +00:00
Automated commit by github action: 14181475866
This commit is contained in:
@@ -2,13 +2,13 @@ get:
|
||||
operationId: listSpConfigObjects
|
||||
security:
|
||||
- userAuth: [sp:config:read, sp:config:manage]
|
||||
x-sailpoint-userLevels:
|
||||
- ORG_ADMIN
|
||||
tags:
|
||||
- SP-Config
|
||||
summary: Get config object details
|
||||
summary: List Config Objects
|
||||
description: >-
|
||||
This gets the list of object configurations which are known to the tenant export/import service.
|
||||
Object configurations that contain "importUrl" and "exportUrl" are available for export/import.
|
||||
|
||||
Get a list of object configurations that the tenant export/import service knows.
|
||||
responses:
|
||||
'200':
|
||||
description: >-
|
||||
|
||||
@@ -1,17 +1,17 @@
|
||||
title: Object Configuration Model
|
||||
description: Response model for get object configuration.
|
||||
description: Response model for object configuration.
|
||||
type: object
|
||||
properties:
|
||||
objectType:
|
||||
type: string
|
||||
description: >-
|
||||
The object type this configuration is for.
|
||||
Object type the configuration is for.
|
||||
example: "TRIGGER_SUBSCRIPTION"
|
||||
referenceExtractors:
|
||||
type: array
|
||||
nullable: true
|
||||
description: >-
|
||||
List of json paths within an exported object of this type that represent references that need to be resolved.
|
||||
List of JSON paths within an exported object of this type, representing references that must be resolved.
|
||||
items:
|
||||
type: string
|
||||
example: ["$.owner"]
|
||||
@@ -19,27 +19,27 @@ properties:
|
||||
type: boolean
|
||||
default: false
|
||||
description: >-
|
||||
If true, this type of object will be JWS signed and cannot be modified before import.
|
||||
Indicates whether this type of object will be JWS signed and cannot be modified before import.
|
||||
example: false
|
||||
alwaysResolveById:
|
||||
type: boolean
|
||||
default: false
|
||||
description: Whether this object type has to be resolved always by ID
|
||||
description: Indicates whether this object type must be always be resolved by ID.
|
||||
example: true
|
||||
legacyObject:
|
||||
type: boolean
|
||||
default: false
|
||||
description: Whether this is a legacy object
|
||||
description: Indicates whether this is a legacy object.
|
||||
example: false
|
||||
onePerTenant:
|
||||
type: boolean
|
||||
default: false
|
||||
description: Whether there is only one object of this type
|
||||
description: Indicates whether there is only one object of this type.
|
||||
example: false
|
||||
exportable:
|
||||
type: boolean
|
||||
default: false
|
||||
description: Whether this object can be exported or it is just a reference object
|
||||
description: Indicates whether the object can be exported or is just a reference object.
|
||||
example: true
|
||||
rules:
|
||||
$ref: ./SpConfigRules.yaml
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
type: object
|
||||
title: Config Object Rule
|
||||
description: Format of Config Hub Object Rules
|
||||
description: Format of Config Hub object rules.
|
||||
properties:
|
||||
path:
|
||||
type: string
|
||||
description: JSONPath expression denoting the path within the object where a value substitution should be applied
|
||||
description: JSONPath expression denoting the path within the object where a value substitution should be applied.
|
||||
example: $.enabled
|
||||
value:
|
||||
anyOf:
|
||||
@@ -14,10 +14,10 @@ properties:
|
||||
- type: number
|
||||
- type: boolean
|
||||
nullable: true
|
||||
description: Value to be assigned at the jsonPath location within the object
|
||||
description: Value to be assigned at the jsonPath location within the object.
|
||||
modes:
|
||||
type: array
|
||||
description: Draft modes to which this rule will apply
|
||||
description: Draft modes the rule will apply to.
|
||||
items:
|
||||
type: string
|
||||
enum:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
type: object
|
||||
title: Config Object Rules
|
||||
description: Rules to be applied to the config object during draft process
|
||||
description: Rules to be applied to the config object during the draft process.
|
||||
properties:
|
||||
takeFromTargetRules:
|
||||
type: array
|
||||
@@ -13,5 +13,5 @@ properties:
|
||||
editable:
|
||||
type: boolean
|
||||
default: false
|
||||
description: Whether this object can be edited
|
||||
description: Indicates whether the object can be edited.
|
||||
example: true
|
||||
@@ -6,10 +6,8 @@ get:
|
||||
- ORG_ADMIN
|
||||
tags:
|
||||
- SP-Config
|
||||
summary: Get config object details
|
||||
description: This gets the list of object configurations which are known to the
|
||||
tenant export/import service. Object configurations that contain "importUrl" and
|
||||
"exportUrl" are available for export/import.
|
||||
summary: List Config Objects
|
||||
description: Get a list of object configurations that the tenant export/import service knows.
|
||||
responses:
|
||||
'200':
|
||||
description: Object configurations returned successfully.
|
||||
|
||||
@@ -1,17 +1,17 @@
|
||||
title: Object Configuration Model
|
||||
description: Response model for get object configuration.
|
||||
description: Response model for object configuration.
|
||||
type: object
|
||||
properties:
|
||||
objectType:
|
||||
type: string
|
||||
description: >-
|
||||
The object type this configuration is for.
|
||||
Object type the configuration is for.
|
||||
example: "TRIGGER_SUBSCRIPTION"
|
||||
referenceExtractors:
|
||||
type: array
|
||||
nullable: true
|
||||
description: >-
|
||||
List of json paths within an exported object of this type that represent references that need to be resolved.
|
||||
List of JSON paths within an exported object of this type, representing references that must be resolved.
|
||||
items:
|
||||
type: string
|
||||
example: ["$.owner"]
|
||||
@@ -19,27 +19,27 @@ properties:
|
||||
type: boolean
|
||||
default: false
|
||||
description: >-
|
||||
If true, this type of object will be JWS signed and cannot be modified before import.
|
||||
Indicates whether this type of object will be JWS signed and cannot be modified before import.
|
||||
example: false
|
||||
alwaysResolveById:
|
||||
type: boolean
|
||||
default: false
|
||||
description: Whether this object type has to be resolved always by ID
|
||||
description: Indicates whether this object type must be always be resolved by ID.
|
||||
example: true
|
||||
legacyObject:
|
||||
type: boolean
|
||||
default: false
|
||||
description: Whether this is a legacy object
|
||||
description: Indicates whether this is a legacy object.
|
||||
example: false
|
||||
onePerTenant:
|
||||
type: boolean
|
||||
default: false
|
||||
description: Whether there is only one object of this type
|
||||
description: Indicates whether there is only one object of this type.
|
||||
example: false
|
||||
exportable:
|
||||
type: boolean
|
||||
default: false
|
||||
description: Whether this object can be exported or it is just a reference object
|
||||
description: Indicates whether the object can be exported or is just a reference object.
|
||||
example: true
|
||||
rules:
|
||||
$ref: ./SpConfigRules.yaml
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
type: object
|
||||
title: Config Object Rule
|
||||
description: Format of Config Hub Object Rules
|
||||
description: Format of Config Hub object rules.
|
||||
properties:
|
||||
path:
|
||||
type: string
|
||||
description: JSONPath expression denoting the path within the object where a value substitution should be applied
|
||||
description: JSONPath expression denoting the path within the object where a value substitution should be applied.
|
||||
example: $.enabled
|
||||
value:
|
||||
anyOf:
|
||||
@@ -14,10 +14,10 @@ properties:
|
||||
- type: number
|
||||
- type: boolean
|
||||
nullable: true
|
||||
description: Value to be assigned at the jsonPath location within the object
|
||||
description: Value to be assigned at the jsonPath location within the object.
|
||||
modes:
|
||||
type: array
|
||||
description: Draft modes to which this rule will apply
|
||||
description: Draft modes the rule will apply to.
|
||||
items:
|
||||
type: string
|
||||
enum:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
type: object
|
||||
title: Config Object Rules
|
||||
description: Rules to be applied to the config object during draft process
|
||||
description: Rules to be applied to the config object during the draft process.
|
||||
properties:
|
||||
takeFromTargetRules:
|
||||
type: array
|
||||
@@ -13,5 +13,5 @@ properties:
|
||||
editable:
|
||||
type: boolean
|
||||
default: false
|
||||
description: Whether this object can be edited
|
||||
description: Indicates whether the object can be edited.
|
||||
example: true
|
||||
@@ -6,10 +6,8 @@ get:
|
||||
- ORG_ADMIN
|
||||
tags:
|
||||
- SP-Config
|
||||
summary: Get config object details
|
||||
description: This gets the list of object configurations which are known to the
|
||||
tenant export/import service. Object configurations that contain "importUrl" and
|
||||
"exportUrl" are available for export/import.
|
||||
summary: List Config Objects
|
||||
description: Get a list of object configurations that the tenant export/import service knows.
|
||||
responses:
|
||||
'200':
|
||||
description: Object configurations returned successfully.
|
||||
|
||||
@@ -1,17 +1,17 @@
|
||||
title: Object Configuration Model
|
||||
description: Response model for get object configuration.
|
||||
description: Response model for object configuration.
|
||||
type: object
|
||||
properties:
|
||||
objectType:
|
||||
type: string
|
||||
description: >-
|
||||
The object type this configuration is for.
|
||||
Object type the configuration is for.
|
||||
example: "TRIGGER_SUBSCRIPTION"
|
||||
referenceExtractors:
|
||||
type: array
|
||||
nullable: true
|
||||
description: >-
|
||||
List of json paths within an exported object of this type that represent references that need to be resolved.
|
||||
List of JSON paths within an exported object of this type, representing references that must be resolved.
|
||||
items:
|
||||
type: string
|
||||
example: ["$.owner"]
|
||||
@@ -19,27 +19,27 @@ properties:
|
||||
type: boolean
|
||||
default: false
|
||||
description: >-
|
||||
If true, this type of object will be JWS signed and cannot be modified before import.
|
||||
Indicates whether this type of object will be JWS signed and cannot be modified before import.
|
||||
example: false
|
||||
alwaysResolveById:
|
||||
type: boolean
|
||||
default: false
|
||||
description: Whether this object type has to be resolved always by ID
|
||||
description: Indicates whether this object type must be always be resolved by ID.
|
||||
example: true
|
||||
legacyObject:
|
||||
type: boolean
|
||||
default: false
|
||||
description: Whether this is a legacy object
|
||||
description: Indicates whether this is a legacy object.
|
||||
example: false
|
||||
onePerTenant:
|
||||
type: boolean
|
||||
default: false
|
||||
description: Whether there is only one object of this type
|
||||
description: Indicates whether there is only one object of this type.
|
||||
example: false
|
||||
exportable:
|
||||
type: boolean
|
||||
default: false
|
||||
description: Whether this object can be exported or it is just a reference object
|
||||
description: Indicates whether the object can be exported or is just a reference object.
|
||||
example: true
|
||||
rules:
|
||||
$ref: ./SpConfigRules.yaml
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
type: object
|
||||
title: Config Object Rule
|
||||
description: Format of Config Hub Object Rules
|
||||
description: Format of Config Hub object rules.
|
||||
properties:
|
||||
path:
|
||||
type: string
|
||||
description: JSONPath expression denoting the path within the object where a value substitution should be applied
|
||||
description: JSONPath expression denoting the path within the object where a value substitution should be applied.
|
||||
example: $.enabled
|
||||
value:
|
||||
anyOf:
|
||||
@@ -14,10 +14,10 @@ properties:
|
||||
- type: number
|
||||
- type: boolean
|
||||
nullable: true
|
||||
description: Value to be assigned at the jsonPath location within the object
|
||||
description: Value to be assigned at the jsonPath location within the object.
|
||||
modes:
|
||||
type: array
|
||||
description: Draft modes to which this rule will apply
|
||||
description: Draft modes the rule will apply to.
|
||||
items:
|
||||
type: string
|
||||
enum:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
type: object
|
||||
title: Config Object Rules
|
||||
description: Rules to be applied to the config object during draft process
|
||||
description: Rules to be applied to the config object during the draft process.
|
||||
properties:
|
||||
takeFromTargetRules:
|
||||
type: array
|
||||
@@ -13,5 +13,5 @@ properties:
|
||||
editable:
|
||||
type: boolean
|
||||
default: false
|
||||
description: Whether this object can be edited
|
||||
description: Indicates whether the object can be edited.
|
||||
example: true
|
||||
Reference in New Issue
Block a user