openapi: 3.0.3
info:
description: |
Complete IdentityIQ REST API documentation covering SCIM, core REST,
UI REST, OAuth2, and External REST endpoints.
version: '9.0'
title: IdentityIQ REST API
servers:
- url: 'http://localhost:8080/identityiq'
description: IdentityIQ server context root.
tags:
- name: Accounts
- name: Alerts
- name: Applications
- name: Account Groups
- name: Analysis
- name: Async Requests
- name: Attachments
- name: Certification Groups
- name: Certifications
- name: Configuration
- name: Debug
- name: Dynamic Scopes
- name: Electronic Signatures
- name: Export
- name: Forms
- name: Groups
- name: Hosts
- name: IIQ
- name: Identities
- name: Identity Requests
- name: Images
- name: Localization
- name: Managed Attributes
- name: Messages
- name: Metadata Validation
- name: Modules
- name: Monitoring
- name: Notifications
- name: Object Configuration
- name: OAuth
- name: Password
- name: Policy
- name: Plugins
- name: Provisioning
- name: Quick Links
- name: Reports
- name: Requests
- name: Access Requests
- name: Rights
- name: Role Mining
- name: Rules
- name: Scoping
- name: Server Statistics
- name: Services
- name: Session
- name: Suggest
- name: Task Results
- name: Task Schedules
- name: UI State
- name: Validation
- name: Work Items
- name: UI Access History
- name: UI Access Request Config
- name: UI Approvals
- name: UI Applications
- name: UI App Onboarding
- name: UI Batch Requests
- name: UI CAM
- name: UI Certifications
- name: UI Configuration
- name: UI Electronic Signatures
- name: UI FAM
- name: UI Forms
- name: UI Groups
- name: UI Identities
- name: UI Identity Operations
- name: UI Identity Preferences
- name: UI Identity Requests
- name: UI Identity Triggers
- name: UI Me
- name: UI Metadata Validation
- name: UI Navigation
- name: UI PAM
- name: UI Policy Violations
- name: UI Preferences
- name: UI Quick Links
- name: UI Risk
- name: UI Scoping
- name: UI Security
- name: UI Session
- name: UI Suggest
- name: UI User Reset
- name: UI Work Items
- name: External
- name: Checked Policy Violations
- name: Entitlements
- name: LaunchedWorkflows
- name: Policy Violations
- name: ResourceTypes
- name: Roles
- name: Schemas
- name: ServiceProviderConfig
- name: Users
- name: Workflows
security:
- basicAuth: []
paths:
/scim/v2/Accounts:
get:
operationId: getAccounts
tags:
- Accounts
summary: Returns all Account resources.
description: This endpoint returns all Account resources.
parameters:
- in: query
name: filter
schema:
type: string
example: application.value eq "7f000001804444fe818051b44414444c" and displayName sw "G"
description: 'Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported.'
- in: query
name: sortBy
schema:
type: string
example: displayName
description: Allows sorting the results by a resource's attributes.
- in: query
name: sortOrder
schema:
type: string
example: descending
default: ascending
description: Determines what order to sort results in.
- in: query
name: startIndex
schema:
type: integer
example: 2313
default: 1
description: Determines the starting index of the result set.
- in: query
name: count
schema:
type: integer
example: 10
default: 1000
description: Specifies the number of results per page.
- in: query
name: attributes
schema:
type: string
example: 'displayName,active'
description: 'A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.'
- in: query
name: excludedAttributes
schema:
type: string
example: 'displayName,active'
description: A comma-separated list of attributes to exclude from the response. *Some attributes cannot be excluded.*
responses:
'200':
description: Returns all Account resources.
content:
application/json:
schema:
properties:
totalResults:
description: Number of Account resources returned
type: integer
example: '18,'
startIndex:
description: The starting index of the resource set list. Can be specified with startIndex query parameter.
type: integer
example: 1
schemas:
description: SCIM Schema used for response.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:api:messages:2.0:ListResponse'
Resources:
type: array
items:
properties:
id:
description: IdentityIQ id of the Account.
type: string
example: c0b4568a4fe7458c434ee77d1fbt156b
identity:
description: The corresponding User object of the Account.
properties:
userName:
description: The identity name of the Account User.
type: string
example: Barbara.Jensen
displayName:
description: The displayable name of the Account User.
type: string
example: Barbara Jensen
value:
description: IdentityIQ identifier for the Account User.
type: string
example: c0a7778b7ef71e79817ee74e6a1f0444
ref:
description: The URI of the SCIM resource representing the Account User.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444'
application:
description: The corresponding Application object of the Account.
properties:
displayName:
description: The displayable name of the Account Application.
type: string
example: Mock Application1
value:
description: IdentityIQ identifier for the Account Application.
type: string
example: c0a7778b7ef71e79817ee74e6a1f0444
ref:
description: The URI of the SCIM resource representing the Account Application.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Applications/c0a7778b7ef71e79817ee74e6a1f0444'
nativeIdentity:
description: The Account unique identifier associated with the native application. This field is immutable.
type: string
example: a1b2c3
displayName:
description: 'The name of the Account, suitable for display to end-users.'
type: string
example: Barbara Jensen
instance:
description: The instance identifier of the Account. This field is immutable.
type: string
example: null
uuid:
description: The UUID of the Account.
type: string
example: '{f99999ff-f000-444b-b6ae-4443dd6cd6ed}'
'urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:APPLICATION NAME:account':
description: 'Provide the name of Application that corresponds to this Account in APPLICATION NAME. This field contains an object structure dependent on the Application that the Account applies to.
Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { "department": "IT"}'
type: object
additionalProperties: true
active:
description: Flag to indicate this account is enabled or disabled.
type: boolean
example: true
locked:
description: 'Flag to indicate this account is locked. An account may be unlocked by setting this attribute to false, but can not be locked by setting a false value to true.'
type: boolean
example: true
manuallyCorrelated:
description: Flag to indicate this account has been manually correlated in the UI.
type: boolean
example: true
hasEntitlements:
description: Flag to indicate this account has one or more entitlement attributes.
type: boolean
example: true
lastRefresh:
description: Datetime representation of the last refresh for this Account.
type: string
format: date-time
lastTargetAggregation:
description: Datetime representation of last targeted aggregation for the Account.
type: string
format: date-time
meta:
description: Metadata of the SCIM resource.
properties:
created:
description: Datetime this resource was created.
type: string
format: date-time
example: '2022-02-11T01:34:04.074-05:00'
location:
description: The location of the resource.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Accounts/c0b4568a4fe7458c434ee77d1fbt156b'
lastModified:
description: Datetime the resource was last modified.
type: string
format: date-time
example: '2022-02-11T01:08:45.866-05:00'
version:
description: The version of the SCIM resource.
type: string
example: W"1644561244074"
resourceType:
description: The resource type.
type: string
example: Account
schemas:
description: The schemas involved in the SCIM resource.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:schemas:sailpoint:1.0:Account'
- 'urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:Mock Application:account'
application/scim+json:
schema:
properties:
totalResults:
description: Number of Account resources returned.
type: integer
example: '1500,'
startIndex:
description: The starting index of the resource set list. Can be specified with startIndex query parameter.
type: integer
example: 1
schemas:
description: SCIM Schema used for response.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:api:messages:2.0:ListResponse'
Resources:
description: The SCIM resources returned for this endpoint.
type: array
items:
properties:
id:
description: IdentityIQ id of the Account.
type: string
example: c0b4568a4fe7458c434ee77d1fbt156b
identity:
description: The corresponding User object of the Account.
properties:
userName:
description: The identity name of the Account User.
type: string
example: Barbara.Jensen
displayName:
description: The displayable name of the Account User.
type: string
example: Barbara Jensen
value:
description: IdentityIQ identifier for the Account User.
type: string
example: c0a7778b7ef71e79817ee74e6a1f0444
ref:
description: The URI of the SCIM resource representing the Account User.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444'
application:
description: The corresponding Application object of the Account.
properties:
displayName:
description: The displayable name of the Account Application.
type: string
example: Mock Application1
value:
description: IdentityIQ identifier for the Account Application.
type: string
example: c0a7778b7ef71e79817ee74e6a1f0444
ref:
description: The URI of the SCIM resource representing the Account Application.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Applications/c0a7778b7ef71e79817ee74e6a1f0444'
nativeIdentity:
description: The Account unique identifier associated with the native application. This field is immutable.
type: string
example: a1b2c3
displayName:
description: 'The name of the Account, suitable for display to end-users.'
type: string
example: Barbara Jensen
instance:
description: The instance identifier of the Account. This field is immutable.
type: string
example: null
uuid:
description: The UUID of the Account.
type: string
example: '{f99999ff-f000-444b-b6ae-4443dd6cd6ed}'
'urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:APPLICATION NAME:account':
description: 'Provide the name of Application that corresponds to this Account in APPLICATION NAME. This field contains an object structure dependent on the Application that the Account applies to.
Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { "department": "IT"}'
type: object
additionalProperties: true
active:
description: Flag to indicate this account is enabled or disabled.
type: boolean
example: true
locked:
description: 'Flag to indicate this account is locked. An account may be unlocked by setting this attribute to false, but can not be locked by setting a false value to true.'
type: boolean
example: true
manuallyCorrelated:
description: Flag to indicate this account has been manually correlated in the UI.
type: boolean
example: true
hasEntitlements:
description: Flag to indicate this account has one or more entitlement attributes.
type: boolean
example: true
lastRefresh:
description: Datetime representation of the last refresh for this Account.
type: string
format: date-time
lastTargetAggregation:
description: Datetime representation of last targeted aggregation for the Account.
type: string
format: date-time
meta:
description: Metadata of the SCIM resource.
properties:
created:
description: Datetime this resource was created.
type: string
format: date-time
example: '2022-02-11T01:34:04.074-05:00'
location:
description: The location of the resource.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Accounts/c0b4568a4fe7458c434ee77d1fbt156b'
lastModified:
description: Datetime the resource was last modified.
type: string
format: date-time
example: '2022-02-11T01:08:45.866-05:00'
version:
description: The version of the SCIM resource.
type: string
example: W"1644561244074"
resourceType:
description: The resource type.
type: string
example: Account
schemas:
description: The schemas involved in the SCIM resource.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:schemas:sailpoint:1.0:Account'
- 'urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:Mock Application:account'
post:
operationId: createAccount
tags:
- Accounts
summary: Creates an Account.
description: The endpoint used to create an Account resource. The required payload fields can differ drastically depending on the Application.
parameters:
- in: query
name: attributes
schema:
type: string
example: 'displayName,active'
description: 'A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.'
- in: query
name: excludedAttributes
schema:
type: string
example: 'displayName,active'
description: A comma-separated list of attributes to exclude from the response. *Some attributes cannot be excluded.*
requestBody:
required: true
content:
application/scim+json:
schema:
properties:
identity:
required:
- value
description: The corresponding User object of the Account.
properties:
userName:
description: The identity name of the Account User.
type: string
example: Barbara.Jensen
displayName:
description: The displayable name of the Account User.
type: string
example: Barbara Jensen
value:
description: IdentityIQ identifier for the Account User.
type: string
example: c0a7778b7ef71e79817ee74e6a1f0444
ref:
description: The URI of the SCIM resource representing the Account User.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444'
application:
required:
- value
description: The corresponding Application object of the Account.
properties:
displayName:
description: The displayable name of the Account Application.
type: string
example: Mock Application1
value:
description: IdentityIQ identifier for the Account Application.
type: string
example: c0a7778b7ef71e79817ee74e6a1f0444
ref:
description: The URI of the SCIM resource representing the Account Application.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Applications/c0a7778b7ef71e79817ee74e6a1f0444'
nativeIdentity:
description: The Account unique identifier associated with the native application. This field is immutable.
type: string
example: a1b2c3
displayName:
description: 'The name of the Account, suitable for display to end-users.'
type: string
example: Barbara Jensen
instance:
description: The instance identifier of the Account. This field is immutable.
type: string
example: mockInstance
password:
description: 'The password of the Account, used in created or changing the Account password. This attribute is write-only and will never be returned in a response.'
type: string
example: useStrongPwd123!
currentPassword:
description: 'The current password of the Account, used in created or changing the Account password. This attribute is write-only and will never be returned in a response.'
type: string
example: useStrongPwd123!
'urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:APPLICATION NAME:account':
description: 'Provide the name of Application that corresponds to this Account in APPLICATION NAME. This field contains an object structure dependent on the Application that the Account applies to.
Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { "department": "IT"}'
type: object
additionalProperties: true
active:
description: Flag to indicate this account is enabled or disabled.
type: boolean
example: true
locked:
description: 'Flag to indicate this account is locked. An account may be unlocked by setting this attribute to false, but can not be locked by setting a false value to true.'
type: boolean
example: true
required:
- identity
- application
- nativeIdentity
- 'urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:APPLICATION NAME:account'
'*/*':
schema:
properties:
identity:
required:
- value
description: The corresponding User object of the Account.
properties:
userName:
description: The identity name of the Account User.
type: string
example: Barbara.Jensen
displayName:
description: The displayable name of the Account User.
type: string
example: Barbara Jensen
value:
description: IdentityIQ identifier for the Account User.
type: string
example: c0a7778b7ef71e79817ee74e6a1f0444
ref:
description: The URI of the SCIM resource representing the Account User.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444'
application:
required:
- value
description: The corresponding Application object of the Account.
properties:
displayName:
description: The displayable name of the Account Application.
type: string
example: Mock Application1
value:
description: IdentityIQ identifier for the Account Application.
type: string
example: c0a7778b7ef71e79817ee74e6a1f0444
ref:
description: The URI of the SCIM resource representing the Account Application.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Applications/c0a7778b7ef71e79817ee74e6a1f0444'
nativeIdentity:
description: The Account unique identifier associated with the native application. This field is immutable.
type: string
example: a1b2c3
displayName:
description: 'The name of the Account, suitable for display to end-users.'
type: string
example: Barbara Jensen
instance:
description: The instance identifier of the Account. This field is immutable.
type: string
example: mockInstance
password:
description: 'The password of the Account, used in created or changing the Account password. This attribute is write-only and will never be returned in a response.'
type: string
example: useStrongPwd123!
currentPassword:
description: 'The current password of the Account, used in created or changing the Account password. This attribute is write-only and will never be returned in a response.'
type: string
example: useStrongPwd123!
'urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:APPLICATION NAME:account':
description: 'Provide the name of Application that corresponds to this Account in APPLICATION NAME. This field contains an object structure dependent on the Application that the Account applies to.
Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { "department": "IT"}'
type: object
additionalProperties: true
active:
description: Flag to indicate this account is enabled or disabled.
type: boolean
example: true
locked:
description: 'Flag to indicate this account is locked. An account may be unlocked by setting this attribute to false, but can not be locked by setting a false value to true.'
type: boolean
example: true
required:
- identity
- application
- nativeIdentity
- 'urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:APPLICATION NAME:account'
responses:
'201':
description: Creates an Account and returns the resultant Account.
content:
application/json:
schema:
properties:
id:
description: IdentityIQ id of the Account.
type: string
example: c0b4568a4fe7458c434ee77d1fbt156b
identity:
description: The corresponding User object of the Account.
properties:
userName:
description: The identity name of the Account User.
type: string
example: Barbara.Jensen
displayName:
description: The displayable name of the Account User.
type: string
example: Barbara Jensen
value:
description: IdentityIQ identifier for the Account User.
type: string
example: c0a7778b7ef71e79817ee74e6a1f0444
ref:
description: The URI of the SCIM resource representing the Account User.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444'
application:
description: The corresponding Application object of the Account.
properties:
displayName:
description: The displayable name of the Account Application.
type: string
example: Mock Application1
value:
description: IdentityIQ identifier for the Account Application.
type: string
example: c0a7778b7ef71e79817ee74e6a1f0444
ref:
description: The URI of the SCIM resource representing the Account Application.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Applications/c0a7778b7ef71e79817ee74e6a1f0444'
nativeIdentity:
description: The Account unique identifier associated with the native application. This field is immutable.
type: string
example: a1b2c3
displayName:
description: 'The name of the Account, suitable for display to end-users.'
type: string
example: Barbara Jensen
instance:
description: The instance identifier of the Account. This field is immutable.
type: string
example: null
uuid:
description: The UUID of the Account.
type: string
example: '{f99999ff-f000-444b-b6ae-4443dd6cd6ed}'
'urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:APPLICATION NAME:account':
description: 'Provide the name of Application that corresponds to this Account in APPLICATION NAME. This field contains an object structure dependent on the Application that the Account applies to.
Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { "department": "IT"}'
type: object
additionalProperties: true
active:
description: Flag to indicate this account is enabled or disabled.
type: boolean
example: true
locked:
description: 'Flag to indicate this account is locked. An account may be unlocked by setting this attribute to false, but can not be locked by setting a false value to true.'
type: boolean
example: true
manuallyCorrelated:
description: Flag to indicate this account has been manually correlated in the UI.
type: boolean
example: true
hasEntitlements:
description: Flag to indicate this account has one or more entitlement attributes.
type: boolean
example: true
lastRefresh:
description: Datetime representation of the last refresh for this Account.
type: string
format: date-time
lastTargetAggregation:
description: Datetime representation of last targeted aggregation for the Account.
type: string
format: date-time
meta:
description: Metadata of the SCIM resource.
properties:
created:
description: Datetime this resource was created.
type: string
format: date-time
example: '2022-02-11T01:34:04.074-05:00'
location:
description: The location of the resource.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Accounts/c0b4568a4fe7458c434ee77d1fbt156b'
lastModified:
description: Datetime the resource was last modified.
type: string
format: date-time
example: '2022-02-11T01:08:45.866-05:00'
version:
description: The version of the SCIM resource.
type: string
example: W"1644561244074"
resourceType:
description: The resource type.
type: string
example: Account
schemas:
description: The schemas involved in the SCIM resource.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:schemas:sailpoint:1.0:Account'
- 'urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:Mock Application:account'
'/scim/v2/Accounts/{accountId}':
get:
operationId: getAccountById
tags:
- Accounts
summary: Returns an Account resource based on id.
description: The Account resource with matching id is returned.
parameters:
- name: accountId
in: path
schema:
type: string
example: c7c7777c7ef77e77777ee77e7a1f0444
description: The id of the Account.
required: true
- in: query
name: attributes
schema:
type: string
example: 'displayName,active'
description: 'A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.'
- in: query
name: excludedAttributes
schema:
type: string
example: 'displayName,active'
description: A comma-separated list of attributes to exclude from the response. *Some attributes cannot be excluded.*
responses:
'200':
description: Returns a single Account resource based on the id.
content:
application/json:
schema:
properties:
id:
description: IdentityIQ id of the Account.
type: string
example: c0b4568a4fe7458c434ee77d1fbt156b
identity:
description: The corresponding User object of the Account.
properties:
userName:
description: The identity name of the Account User.
type: string
example: Barbara.Jensen
displayName:
description: The displayable name of the Account User.
type: string
example: Barbara Jensen
value:
description: IdentityIQ identifier for the Account User.
type: string
example: c0a7778b7ef71e79817ee74e6a1f0444
ref:
description: The URI of the SCIM resource representing the Account User.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444'
application:
description: The corresponding Application object of the Account.
properties:
displayName:
description: The displayable name of the Account Application.
type: string
example: Mock Application1
value:
description: IdentityIQ identifier for the Account Application.
type: string
example: c0a7778b7ef71e79817ee74e6a1f0444
ref:
description: The URI of the SCIM resource representing the Account Application.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Applications/c0a7778b7ef71e79817ee74e6a1f0444'
nativeIdentity:
description: The Account unique identifier associated with the native application. This field is immutable.
type: string
example: a1b2c3
displayName:
description: 'The name of the Account, suitable for display to end-users.'
type: string
example: Barbara Jensen
instance:
description: The instance identifier of the Account. This field is immutable.
type: string
example: null
uuid:
description: The UUID of the Account.
type: string
example: '{f99999ff-f000-444b-b6ae-4443dd6cd6ed}'
'urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:APPLICATION NAME:account':
description: 'Provide the name of Application that corresponds to this Account in APPLICATION NAME. This field contains an object structure dependent on the Application that the Account applies to.
Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { "department": "IT"}'
type: object
additionalProperties: true
active:
description: Flag to indicate this account is enabled or disabled.
type: boolean
example: true
locked:
description: 'Flag to indicate this account is locked. An account may be unlocked by setting this attribute to false, but can not be locked by setting a false value to true.'
type: boolean
example: true
manuallyCorrelated:
description: Flag to indicate this account has been manually correlated in the UI.
type: boolean
example: true
hasEntitlements:
description: Flag to indicate this account has one or more entitlement attributes.
type: boolean
example: true
lastRefresh:
description: Datetime representation of the last refresh for this Account.
type: string
format: date-time
lastTargetAggregation:
description: Datetime representation of last targeted aggregation for the Account.
type: string
format: date-time
meta:
description: Metadata of the SCIM resource.
properties:
created:
description: Datetime this resource was created.
type: string
format: date-time
example: '2022-02-11T01:34:04.074-05:00'
location:
description: The location of the resource.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Accounts/c0b4568a4fe7458c434ee77d1fbt156b'
lastModified:
description: Datetime the resource was last modified.
type: string
format: date-time
example: '2022-02-11T01:08:45.866-05:00'
version:
description: The version of the SCIM resource.
type: string
example: W"1644561244074"
resourceType:
description: The resource type.
type: string
example: Account
schemas:
description: The schemas involved in the SCIM resource.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:schemas:sailpoint:1.0:Account'
- 'urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:Mock Application:account'
application/scim+json:
schema:
properties:
id:
description: IdentityIQ id of the Account.
type: string
example: c0b4568a4fe7458c434ee77d1fbt156b
identity:
description: The corresponding User object of the Account.
properties:
userName:
description: The identity name of the Account User.
type: string
example: Barbara.Jensen
displayName:
description: The displayable name of the Account User.
type: string
example: Barbara Jensen
value:
description: IdentityIQ identifier for the Account User.
type: string
example: c0a7778b7ef71e79817ee74e6a1f0444
ref:
description: The URI of the SCIM resource representing the Account User.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444'
application:
description: The corresponding Application object of the Account.
properties:
displayName:
description: The displayable name of the Account Application.
type: string
example: Mock Application1
value:
description: IdentityIQ identifier for the Account Application.
type: string
example: c0a7778b7ef71e79817ee74e6a1f0444
ref:
description: The URI of the SCIM resource representing the Account Application.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Applications/c0a7778b7ef71e79817ee74e6a1f0444'
nativeIdentity:
description: The Account unique identifier associated with the native application. This field is immutable.
type: string
example: a1b2c3
displayName:
description: 'The name of the Account, suitable for display to end-users.'
type: string
example: Barbara Jensen
instance:
description: The instance identifier of the Account. This field is immutable.
type: string
example: null
uuid:
description: The UUID of the Account.
type: string
example: '{f99999ff-f000-444b-b6ae-4443dd6cd6ed}'
'urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:APPLICATION NAME:account':
description: 'Provide the name of Application that corresponds to this Account in APPLICATION NAME. This field contains an object structure dependent on the Application that the Account applies to.
Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { "department": "IT"}'
type: object
additionalProperties: true
active:
description: Flag to indicate this account is enabled or disabled.
type: boolean
example: true
locked:
description: 'Flag to indicate this account is locked. An account may be unlocked by setting this attribute to false, but can not be locked by setting a false value to true.'
type: boolean
example: true
manuallyCorrelated:
description: Flag to indicate this account has been manually correlated in the UI.
type: boolean
example: true
hasEntitlements:
description: Flag to indicate this account has one or more entitlement attributes.
type: boolean
example: true
lastRefresh:
description: Datetime representation of the last refresh for this Account.
type: string
format: date-time
lastTargetAggregation:
description: Datetime representation of last targeted aggregation for the Account.
type: string
format: date-time
meta:
description: Metadata of the SCIM resource.
properties:
created:
description: Datetime this resource was created.
type: string
format: date-time
example: '2022-02-11T01:34:04.074-05:00'
location:
description: The location of the resource.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Accounts/c0b4568a4fe7458c434ee77d1fbt156b'
lastModified:
description: Datetime the resource was last modified.
type: string
format: date-time
example: '2022-02-11T01:08:45.866-05:00'
version:
description: The version of the SCIM resource.
type: string
example: W"1644561244074"
resourceType:
description: The resource type.
type: string
example: Account
schemas:
description: The schemas involved in the SCIM resource.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:schemas:sailpoint:1.0:Account'
- 'urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:Mock Application:account'
put:
operationId: updateAccount
tags:
- Accounts
summary: Updates an existing Account.
description: The endpoint used to update an Account resource. The required payload fields depend on the corresponding Application.
parameters:
- name: accountId
in: path
schema:
type: string
example: c7c7777c7ef77e77777ee77e7a1f0444
description: The id of the Account.
required: true
- in: query
name: attributes
schema:
type: string
example: 'displayName,active'
description: 'A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.'
- in: query
name: excludedAttributes
schema:
type: string
example: 'displayName,active'
description: A comma-separated list of attributes to exclude from the response. *Some attributes cannot be excluded.*
requestBody:
required: true
content:
application/scim+json:
schema:
properties:
identity:
required:
- value
description: The corresponding User object of the Account.
properties:
userName:
description: The identity name of the Account User.
type: string
example: Barbara.Jensen
displayName:
description: The displayable name of the Account User.
type: string
example: Barbara Jensen
value:
description: IdentityIQ identifier for the Account User.
type: string
example: c0a7778b7ef71e79817ee74e6a1f0444
ref:
description: The URI of the SCIM resource representing the Account User.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444'
application:
required:
- value
description: The corresponding Application object of the Account.
properties:
displayName:
description: The displayable name of the Account Application.
type: string
example: Mock Application1
value:
description: IdentityIQ identifier for the Account Application.
type: string
example: c0a7778b7ef71e79817ee74e6a1f0444
ref:
description: The URI of the SCIM resource representing the Account Application.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Applications/c0a7778b7ef71e79817ee74e6a1f0444'
nativeIdentity:
description: The Account unique identifier associated with the native application. This field is immutable.
type: string
example: a1b2c3
displayName:
description: 'The name of the Account, suitable for display to end-users.'
type: string
example: Barbara Jensen
instance:
description: The instance identifier of the Account. This field is immutable.
type: string
example: mockInstance
password:
description: 'The password of the Account, used in created or changing the Account password. This attribute is write-only and will never be returned in a response.'
type: string
example: useStrongPwd123!
currentPassword:
description: 'The current password of the Account, used in created or changing the Account password. This attribute is write-only and will never be returned in a response.'
type: string
example: useStrongPwd123!
'urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:APPLICATION NAME:account':
description: 'Provide the name of Application that corresponds to this Account in APPLICATION NAME. This field contains an object structure dependent on the Application that the Account applies to.
Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { "department": "IT"}'
type: object
additionalProperties: true
active:
description: Flag to indicate this account is enabled or disabled.
type: boolean
example: true
locked:
description: 'Flag to indicate this account is locked. An account may be unlocked by setting this attribute to false, but can not be locked by setting a false value to true.'
type: boolean
example: true
required:
- identity
- application
- nativeIdentity
- 'urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:APPLICATION NAME:account'
'*/*':
schema:
properties:
identity:
required:
- value
description: The corresponding User object of the Account.
properties:
userName:
description: The identity name of the Account User.
type: string
example: Barbara.Jensen
displayName:
description: The displayable name of the Account User.
type: string
example: Barbara Jensen
value:
description: IdentityIQ identifier for the Account User.
type: string
example: c0a7778b7ef71e79817ee74e6a1f0444
ref:
description: The URI of the SCIM resource representing the Account User.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444'
application:
required:
- value
description: The corresponding Application object of the Account.
properties:
displayName:
description: The displayable name of the Account Application.
type: string
example: Mock Application1
value:
description: IdentityIQ identifier for the Account Application.
type: string
example: c0a7778b7ef71e79817ee74e6a1f0444
ref:
description: The URI of the SCIM resource representing the Account Application.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Applications/c0a7778b7ef71e79817ee74e6a1f0444'
nativeIdentity:
description: The Account unique identifier associated with the native application. This field is immutable.
type: string
example: a1b2c3
displayName:
description: 'The name of the Account, suitable for display to end-users.'
type: string
example: Barbara Jensen
instance:
description: The instance identifier of the Account. This field is immutable.
type: string
example: mockInstance
password:
description: 'The password of the Account, used in created or changing the Account password. This attribute is write-only and will never be returned in a response.'
type: string
example: useStrongPwd123!
currentPassword:
description: 'The current password of the Account, used in created or changing the Account password. This attribute is write-only and will never be returned in a response.'
type: string
example: useStrongPwd123!
'urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:APPLICATION NAME:account':
description: 'Provide the name of Application that corresponds to this Account in APPLICATION NAME. This field contains an object structure dependent on the Application that the Account applies to.
Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { "department": "IT"}'
type: object
additionalProperties: true
active:
description: Flag to indicate this account is enabled or disabled.
type: boolean
example: true
locked:
description: 'Flag to indicate this account is locked. An account may be unlocked by setting this attribute to false, but can not be locked by setting a false value to true.'
type: boolean
example: true
required:
- identity
- application
- nativeIdentity
- 'urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:APPLICATION NAME:account'
responses:
'200':
description: Updates an existing Account and returns that Account.
content:
application/json:
schema:
properties:
id:
description: IdentityIQ id of the Account.
type: string
example: c0b4568a4fe7458c434ee77d1fbt156b
identity:
description: The corresponding User object of the Account.
properties:
userName:
description: The identity name of the Account User.
type: string
example: Barbara.Jensen
displayName:
description: The displayable name of the Account User.
type: string
example: Barbara Jensen
value:
description: IdentityIQ identifier for the Account User.
type: string
example: c0a7778b7ef71e79817ee74e6a1f0444
ref:
description: The URI of the SCIM resource representing the Account User.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444'
application:
description: The corresponding Application object of the Account.
properties:
displayName:
description: The displayable name of the Account Application.
type: string
example: Mock Application1
value:
description: IdentityIQ identifier for the Account Application.
type: string
example: c0a7778b7ef71e79817ee74e6a1f0444
ref:
description: The URI of the SCIM resource representing the Account Application.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Applications/c0a7778b7ef71e79817ee74e6a1f0444'
nativeIdentity:
description: The Account unique identifier associated with the native application. This field is immutable.
type: string
example: a1b2c3
displayName:
description: 'The name of the Account, suitable for display to end-users.'
type: string
example: Barbara Jensen
instance:
description: The instance identifier of the Account. This field is immutable.
type: string
example: null
uuid:
description: The UUID of the Account.
type: string
example: '{f99999ff-f000-444b-b6ae-4443dd6cd6ed}'
'urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:APPLICATION NAME:account':
description: 'Provide the name of Application that corresponds to this Account in APPLICATION NAME. This field contains an object structure dependent on the Application that the Account applies to.
Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { "department": "IT"}'
type: object
additionalProperties: true
active:
description: Flag to indicate this account is enabled or disabled.
type: boolean
example: true
locked:
description: 'Flag to indicate this account is locked. An account may be unlocked by setting this attribute to false, but can not be locked by setting a false value to true.'
type: boolean
example: true
manuallyCorrelated:
description: Flag to indicate this account has been manually correlated in the UI.
type: boolean
example: true
hasEntitlements:
description: Flag to indicate this account has one or more entitlement attributes.
type: boolean
example: true
lastRefresh:
description: Datetime representation of the last refresh for this Account.
type: string
format: date-time
lastTargetAggregation:
description: Datetime representation of last targeted aggregation for the Account.
type: string
format: date-time
meta:
description: Metadata of the SCIM resource.
properties:
created:
description: Datetime this resource was created.
type: string
format: date-time
example: '2022-02-11T01:34:04.074-05:00'
location:
description: The location of the resource.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Accounts/c0b4568a4fe7458c434ee77d1fbt156b'
lastModified:
description: Datetime the resource was last modified.
type: string
format: date-time
example: '2022-02-11T01:08:45.866-05:00'
version:
description: The version of the SCIM resource.
type: string
example: W"1644561244074"
resourceType:
description: The resource type.
type: string
example: Account
schemas:
description: The schemas involved in the SCIM resource.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:schemas:sailpoint:1.0:Account'
- 'urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:Mock Application:account'
delete:
operationId: deleteAccount
tags:
- Accounts
summary: Deletes an existing Account.
description: The endpoint used to delete an Account resource. **This is not reversible.**
parameters:
- name: accountId
in: path
schema:
type: string
example: c7c7777c7ef77e77777ee77e7a1f0444
description: The id of the Account.
required: true
responses:
'204':
description: Returns a 204 with no response body if delete was successful.
/scim/v2/Alerts:
get:
operationId: getAlerts
tags:
- Alerts
summary: Returns all Alert resources.
description: |
This endpoint returns all Alert resources.
Attributes to include in the response can be specified with the 'attributes' query parameter.
Attributes to exclude from the response can be specified with the 'excludedAttributes' query parameter.
The schemas related to Alerts are:
- **urn:ietf:params:scim:schemas:core:1.0:Alert**
- **urn:ietf:params:scim:schemas:core:1.0:AlertInput**
parameters:
- in: query
name: filter
schema:
type: string
example: name eq "0000000001"
description: 'Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported.'
- in: query
name: lookupByName
schema:
type: boolean
default: false
example: true
description: Set to true if the Alert name is passed instead of the Alert id.
- in: query
name: sortBy
schema:
type: string
example: name
description: Allows sorting the results by a resource's attributes.
- in: query
name: sortOrder
schema:
type: string
default: ascending
example: descending
description: Determines what order to sort results in.
- in: query
name: startIndex
schema:
type: integer
example: '10'
default: 1
description: Determines the starting index of the result set.
- in: query
name: count
schema:
type: integer
example: '10'
default: 1000
description: Specifies the number of results per page.
- in: query
name: attributes
schema:
type: string
example: name
description: 'A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.'
- in: query
name: excludedAttributes
schema:
type: string
example: 'name, application'
description: A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**
responses:
'200':
description: Returned all SCIM resources for this endpoint.
content:
application/json:
schema:
properties:
totalResults:
description: Number of resources returned for this endpoint.
type: integer
example: '1,'
startIndex:
description: The starting index of the resource set list. Can be specified with startIndex query parameter.
type: integer
example: 1
schemas:
description: SCIM Schema used for response.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:api:messages:2.0:ListResponse'
Resources:
type: array
items:
properties:
id:
description: Unique identifier of the Alert.
type: string
example: c0a8019c7fe11678817fe18984351477
name:
description: 'Name of the Alert, auto-generated by the SCIM Server.'
type: string
example: '0000000001'
displayName:
description: Display name of the Alert.
type: string
example: Hello World!
type:
description: Type of the Alert.
type: string
example: Permission
attributes:
description: A list of attributes of the Alert.
type: array
items:
properties:
value:
description: The attribute value.
type: string
example: Grackle5.Test.Sailpoint.com
key:
description: The attribute key.
type: string
example: bamName
application:
description: The corresponding Application object of the Alert.
type: object
properties:
value:
description: The Application associated with the Alert.
type: string
example: Active_Directory
$ref:
description: The URI of the SCIM resource representating the Alert application.
type: object
example: 'http://localhost:8080/identityiq/scim/v2/Applications/7f00000180281df7818028bfed100826'
displayName:
description: The name of the Alert Application.
type: string
example: Active_Directory
actions:
description: Not empty if action was taken on the Alert.
type: array
items:
properties:
type:
description: The type of action performed as a result of the Alert.
type: string
enum:
- WORKFLOW
- CERTIFICATION
- NOTIFICATION
example: WORKFLOW
alertDefinitionName:
description: The name of the Alert Definition that triggered the action.
type: string
example: lowSeverityAlertDefinition
resultId:
description: 'Typically actions create other objects, a certificationId or workflowId as a result of the action taken.'
type: string
example: 7f00000180281df7818028c109ea1742
result:
description: The Task Result of the Alert.
type: array
items:
properties:
name:
description: The name of the Task Result for the Alert action.
type: string
workflowName:
description: The name of the Workflow used in the Alert action task result.
type: string
example: LCM Provisioning
notifications:
description: Notifications to send when a Alert action is generated.
type: array
items:
properties:
name:
description: The name of configured notifications for Alert action results.
type: string
example: lowLevelAlertNotification
displayName:
description: Display name for the Alert action notification.
type: string
example: lowLevelAlert result notification
emailAddresses:
description: A list of email addresses to send an Alert action notification.
type: string
example: 'amanda.ross@demoexample.com, alice.ford@demoexample.com'
alertDate:
description: 'The Alert DateTime, this could have different meanings based on the type of alert.'
type: string
format: date-time
example: '2022-03-31T14:52:40.265-05:00'
lastProcessed:
description: 'The DateTime of the last time the alert was processed, this does not indicate the system took action on the Alert.'
type: string
format: date-time
example: '2022-03-31T14:52:40.260-05:00'
nativeId:
description: Unique Identifier of the Alert in the native system.
type: string
example: 420bebfb-c87a-406f-930c-29e06feb47bc
targetId:
description: Unique Identifier of the target object which caused the Alert.
type: string
example: c0a8019c7fe51750817fe634a6b10171
targetType:
description: The type of SailPointObject the target is.
type: string
example: Certification
targetDisplayName:
description: User friendly display name of the target object.
type: string
example: Manager Certification
meta:
description: Metadata for the Alert.
type: array
items:
properties:
created:
description: DateTime when the Alert was created.
type: string
format: date-time
example: '2022-03-31T14:52:40.245-05:00'
location:
description: URL to the Alert.
type: string
example: 'http://localhost:8080/identityiq/scim/v2/Alerts/c0a8019c7fe11678817fe18984351477'
lastModified:
description: DateTime of Alert last modification.
type: string
format: date-time
example: '2022-03-31T14:52:40.265-05:00'
version:
description: Alert version.
type: string
example: W"1650050901217"
resourceType:
description: Resource type of the metadata subject.
type: string
example: Alert
schemas:
description: A list of the schemas used for Alerts.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:schemas:sailpoint:1.0:AlertInput'
- 'urn:ietf:params:scim:schemas:sailpoint:1.0:Alert'
application/scim+json:
schema:
properties:
totalResults:
description: Number of Alert resources returned.
type: integer
example: '1500,'
startIndex:
description: The starting index of the resource set list. Can be specified with startIndex query parameter.
type: integer
example: 1
schemas:
description: SCIM Schema used for response.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:api:messages:2.0:ListResponse'
Resources:
description: The SCIM resources returned for this endpoint.
type: array
items:
properties:
id:
description: Unique identifier of the Alert.
type: string
example: c0a8019c7fe11678817fe18984351477
name:
description: 'Name of the Alert, auto-generated by the SCIM Server.'
type: string
example: '0000000001'
displayName:
description: Display name of the Alert.
type: string
example: Hello World!
type:
description: Type of the Alert.
type: string
example: Permission
attributes:
description: A list of attributes of the Alert.
type: array
items:
properties:
value:
description: The attribute value.
type: string
example: Grackle5.Test.Sailpoint.com
key:
description: The attribute key.
type: string
example: bamName
application:
description: The corresponding Application object of the Alert.
type: object
properties:
value:
description: The Application associated with the Alert.
type: string
example: Active_Directory
$ref:
description: The URI of the SCIM resource representating the Alert application.
type: object
example: 'http://localhost:8080/identityiq/scim/v2/Applications/7f00000180281df7818028bfed100826'
displayName:
description: The name of the Alert Application.
type: string
example: Active_Directory
actions:
description: Not empty if action was taken on the Alert.
type: array
items:
properties:
type:
description: The type of action performed as a result of the Alert.
type: string
enum:
- WORKFLOW
- CERTIFICATION
- NOTIFICATION
example: WORKFLOW
alertDefinitionName:
description: The name of the Alert Definition that triggered the action.
type: string
example: lowSeverityAlertDefinition
resultId:
description: 'Typically actions create other objects, a certificationId or workflowId as a result of the action taken.'
type: string
example: 7f00000180281df7818028c109ea1742
result:
description: The Task Result of the Alert.
type: array
items:
properties:
name:
description: The name of the Task Result for the Alert action.
type: string
workflowName:
description: The name of the Workflow used in the Alert action task result.
type: string
example: LCM Provisioning
notifications:
description: Notifications to send when a Alert action is generated.
type: array
items:
properties:
name:
description: The name of configured notifications for Alert action results.
type: string
example: lowLevelAlertNotification
displayName:
description: Display name for the Alert action notification.
type: string
example: lowLevelAlert result notification
emailAddresses:
description: A list of email addresses to send an Alert action notification.
type: string
example: 'amanda.ross@demoexample.com, alice.ford@demoexample.com'
alertDate:
description: 'The Alert DateTime, this could have different meanings based on the type of alert.'
type: string
format: date-time
example: '2022-03-31T14:52:40.265-05:00'
lastProcessed:
description: 'The DateTime of the last time the alert was processed, this does not indicate the system took action on the Alert.'
type: string
format: date-time
example: '2022-03-31T14:52:40.260-05:00'
nativeId:
description: Unique Identifier of the Alert in the native system.
type: string
example: 420bebfb-c87a-406f-930c-29e06feb47bc
targetId:
description: Unique Identifier of the target object which caused the Alert.
type: string
example: c0a8019c7fe51750817fe634a6b10171
targetType:
description: The type of SailPointObject the target is.
type: string
example: Certification
targetDisplayName:
description: User friendly display name of the target object.
type: string
example: Manager Certification
meta:
description: Metadata for the Alert.
type: array
items:
properties:
created:
description: DateTime when the Alert was created.
type: string
format: date-time
example: '2022-03-31T14:52:40.245-05:00'
location:
description: URL to the Alert.
type: string
example: 'http://localhost:8080/identityiq/scim/v2/Alerts/c0a8019c7fe11678817fe18984351477'
lastModified:
description: DateTime of Alert last modification.
type: string
format: date-time
example: '2022-03-31T14:52:40.265-05:00'
version:
description: Alert version.
type: string
example: W"1650050901217"
resourceType:
description: Resource type of the metadata subject.
type: string
example: Alert
schemas:
description: A list of the schemas used for Alerts.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:schemas:sailpoint:1.0:AlertInput'
- 'urn:ietf:params:scim:schemas:sailpoint:1.0:Alert'
post:
operationId: createAlert
tags:
- Alerts
summary: Creates a new Alert.
description: The endpoint used to create an Alert resource.
parameters:
- in: query
name: attributes
schema:
type: string
example: name
description: 'A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.'
- in: query
name: excludedAttributes
schema:
type: string
example: 'name, application'
description: A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**
requestBody:
required: true
content:
application/scim+json:
schema:
properties:
displayName:
description: Display name of the Alert.
type: string
example: Confidential File Opened
type:
description: Type of the Alert.
type: string
example: alert
attributes:
description: A list of attributes of the Alert.
type: array
items:
properties:
key:
description: The attribute key.
type: string
example: userFullName
value:
description: The attribute value.
type: string
example: TEST/Anne.Arnold
alertDate:
description: 'The Alert DateTime, this could have different meanings based on the type of alert.'
type: string
format: date-time
example: '2022-05-04T13:24:09.661-05:00'
nativeId:
description: Unique Identifier of the Alert in the native system.
type: string
example: '2351234513245349'
targetId:
description: Unique Identifier of the target object which caused the Alert.
type: string
example: 2c9091d24f65486f014f6568be4400f7
targetType:
description: The type of SailPointObject the target is.
type: string
example: Identity
targetDisplayName:
description: User friendly display name of the target object.
type: string
example: Anne.Arnold
application:
description: The corresponding Application object of the Alert.
type: object
properties:
displayName:
description: The name of the Alert Application. OPTIONAL and READ-ONLY.
type: string
example: JDBCDirectAlerts
value:
description: The Application associated with the Alert.
type: string
example: 7f00000180281df7818028bfed100826
$ref:
description: The URI of the SCIM resource representating the Alert application.
type: string
example: 'http://localhost:8080/identityiq/scim/v2/Applications/7f00000180281df7818028bfed100826'
responses:
'201':
description: Creates an Alert and returns the resultant Alert.
content:
application/json:
schema:
properties:
id:
description: Unique identifier of the Alert.
type: string
example: c0a8019c7fe11678817fe18984351477
name:
description: 'Name of the Alert, auto-generated by the SCIM Server.'
type: string
example: '0000000001'
displayName:
description: Display name of the Alert.
type: string
example: Hello World!
type:
description: Type of the Alert.
type: string
example: Permission
attributes:
description: A list of attributes of the Alert.
type: array
items:
properties:
value:
description: The attribute value.
type: string
example: Grackle5.Test.Sailpoint.com
key:
description: The attribute key.
type: string
example: bamName
application:
description: The corresponding Application object of the Alert.
type: object
properties:
value:
description: The Application associated with the Alert.
type: string
example: Active_Directory
$ref:
description: The URI of the SCIM resource representating the Alert application.
type: object
example: 'http://localhost:8080/identityiq/scim/v2/Applications/7f00000180281df7818028bfed100826'
displayName:
description: The name of the Alert Application.
type: string
example: Active_Directory
actions:
description: Not empty if action was taken on the Alert.
type: array
items:
properties:
type:
description: The type of action performed as a result of the Alert.
type: string
enum:
- WORKFLOW
- CERTIFICATION
- NOTIFICATION
example: WORKFLOW
alertDefinitionName:
description: The name of the Alert Definition that triggered the action.
type: string
example: lowSeverityAlertDefinition
resultId:
description: 'Typically actions create other objects, a certificationId or workflowId as a result of the action taken.'
type: string
example: 7f00000180281df7818028c109ea1742
result:
description: The Task Result of the Alert.
type: array
items:
properties:
name:
description: The name of the Task Result for the Alert action.
type: string
workflowName:
description: The name of the Workflow used in the Alert action task result.
type: string
example: LCM Provisioning
notifications:
description: Notifications to send when a Alert action is generated.
type: array
items:
properties:
name:
description: The name of configured notifications for Alert action results.
type: string
example: lowLevelAlertNotification
displayName:
description: Display name for the Alert action notification.
type: string
example: lowLevelAlert result notification
emailAddresses:
description: A list of email addresses to send an Alert action notification.
type: string
example: 'amanda.ross@demoexample.com, alice.ford@demoexample.com'
alertDate:
description: 'The Alert DateTime, this could have different meanings based on the type of alert.'
type: string
format: date-time
example: '2022-03-31T14:52:40.265-05:00'
lastProcessed:
description: 'The DateTime of the last time the alert was processed, this does not indicate the system took action on the Alert.'
type: string
format: date-time
example: '2022-03-31T14:52:40.260-05:00'
nativeId:
description: Unique Identifier of the Alert in the native system.
type: string
example: 420bebfb-c87a-406f-930c-29e06feb47bc
targetId:
description: Unique Identifier of the target object which caused the Alert.
type: string
example: c0a8019c7fe51750817fe634a6b10171
targetType:
description: The type of SailPointObject the target is.
type: string
example: Certification
targetDisplayName:
description: User friendly display name of the target object.
type: string
example: Manager Certification
meta:
description: Metadata for the Alert.
type: array
items:
properties:
created:
description: DateTime when the Alert was created.
type: string
format: date-time
example: '2022-03-31T14:52:40.245-05:00'
location:
description: URL to the Alert.
type: string
example: 'http://localhost:8080/identityiq/scim/v2/Alerts/c0a8019c7fe11678817fe18984351477'
lastModified:
description: DateTime of Alert last modification.
type: string
format: date-time
example: '2022-03-31T14:52:40.265-05:00'
version:
description: Alert version.
type: string
example: W"1650050901217"
resourceType:
description: Resource type of the metadata subject.
type: string
example: Alert
schemas:
description: A list of the schemas used for Alerts.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:schemas:sailpoint:1.0:AlertInput'
- 'urn:ietf:params:scim:schemas:sailpoint:1.0:Alert'
'/scim/v2/Alerts/{alertId}':
get:
operationId: getAlertById
tags:
- Alerts
summary: Returns an Alert resource based on id.
description: |
>The Alert resource with matching id is returned.
>Attributes to include in the response can be specified with the attributes query parameter.
>Attributes to exclude from the response can be specified with the excludedAttributes query parameter.
parameters:
- name: alertId
in: path
schema:
type: string
example: c0a8019c802d1e5a81802eb2b57e020f
description: id of Alert resource.
required: true
- in: query
name: attributes
schema:
type: string
example: name
description: 'A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.'
- in: query
name: excludedAttributes
schema:
type: string
example: 'name, application'
description: A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**
responses:
'200':
description: Returns a single Alert resource based on the id.
content:
application/json:
schema:
properties:
id:
description: Unique identifier of the Alert.
type: string
example: c0a8019c7ffa186e817ffb80170a0195
name:
description: 'Name of the Alert, auto-generated by the SCIM Server.'
type: string
example: '0000000002'
displayName:
description: Display name of the Alert.
type: string
example: Workflow Alert
type:
description: Type of the Alert.
type: string
example: Business Process Alert
attributes:
description: A list of attributes of the Alert.
type: array
items:
properties:
value:
description: The attribute value.
type: string
example: Windows File Server (Agent)
key:
description: The attribute key.
type: string
example: applicationType
application:
description: The corresponding Application object of the Alert.
type: array
items:
properties:
value:
description: The Application associated with the Alert.
type: string
example: SAP
$ref:
description: The URI of the SCIM resource representating the Alert application.
type: string
example: 'http://localhost:8080/identityiq/scim/v2/Applications/7f00000180281df7818028bfed100826'
displayName:
description: The name of the Alert Application. OPTIONAL and READ-ONLY.
type: string
example: SAP Financial App
actions:
description: Alert actions.
type: array
items:
properties:
type:
description: The type of action performed as a result of the Alert.
type: string
enum:
- WORKFLOW
- CERTIFICATION
- NOTIFICATION
example: Certification
alertDefinitionName:
description: The name of the Alert Definition that triggered the action.
type: string
example: certLauncher
resultId:
description: 'Typically actions create other objects, a certificationId or workflowId as a result of the action taken.'
type: string
example: 7f00000180281df7818028c109ea1742
result:
description: The Task Result of the Alert.
type: array
items:
properties:
name:
description: The name of the Task Result for the Alert action.
type: string
example: Alert 0000000001 Certification Result
workflowName:
description: The name of the Workflow used in the Alert action task result.
type: string
example: refreshCerficationSchedule
notifications:
type: array
description: Notifications to send when a Alert action is generated.
items:
properties:
name:
description: The name of configured notifications for Alert action results.
type: string
example: 000000009
displayName:
description: Display name for the Alert action notification.
type: string
example: Certification Refresh Notification for James.Smith
emailAddresses:
description: A list of email addresses to send an Alert action notification.
type: string
example: james.smith@demoexample.com
alertDate:
description: 'The Alert DateTime, this could have different meanings based on the type of alert.'
type: string
format: date-time
example: '2022-03-31T14:52:40.265-05:00'
lastProcessed:
description: 'The DateTime of the last time the Alert was processed, this does not indicate the system took action on the Alert.'
type: string
format: date-time
example: '2022-03-31T14:52:40.260-05:00'
nativeId:
description: Unique Identifier of the Alert in the native system.
type: string
example: 420bebfb-c87a-406f-930c-29e06feb47bc
targetId:
description: Unique Identifier of the target object which caused the Alert.
type: string
example: c0a8019c7fe51750817fe634a6b10171
targetType:
description: The type of SailPointObject the target is.
type: string
example: Certification
targetDisplayName:
description: User friendly display name of the target object.
type: string
example: Manager Certification
meta:
type: object
properties:
created:
description: DateTime when the Alert was created.
type: string
format: date-time
example: '2022-04-05T15:52:30.090-05:00'
location:
description: URL to the Alert.
type: string
example: 'http://localhost:8080/identityiq/scim/v2/Alerts/c0a8019c7ffa186e817ffb80170a0195'
lastModified:
description: DateTime of Alert last modification.
type: string
format: date-time
example: '2022-04-05T15:52:30.119-05:00'
version:
description: Alert version.
type: string
example: W"1649191950119"
resourceType:
description: Resource type of the metadata subject.
type: string
example: Alert
/scim/v2/Applications:
get:
operationId: getApplications
tags:
- Applications
summary: Returns all Application resources.
description: |
This endpoint returns all Application resources.
Attributes to include in the response can be specified with the 'attributes' query parameter.
Attributes to exclude from the response can be specified with the 'excludedAttributes' query parameter.
The schema related to Applications is:
- **urn:ietf:params:scim:schemas:core:1.0:Application**
parameters:
- in: query
name: filter
schema:
type: string
example: type eq "Active Directory - Direct"
description: 'Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported.'
- in: query
name: lookupByName
schema:
type: boolean
default: false
example: true
- in: query
name: sortBy
schema:
type: string
example: name
description: Allows sorting the results by a resource's attributes.
- in: query
name: sortOrder
schema:
type: string
default: ascending
example: descending
description: Determines what order to sort results in.
- in: query
name: startIndex
schema:
type: integer
example: 10
default: 1
description: Determines the starting index of the result set.
- in: query
name: count
schema:
type: integer
example: 10
default: 1
description: Specifies the number of results per page.
- in: query
name: attributes
schema:
type: string
example: 'name,type,features'
description: 'The Application attributes to include in the response. The query parameter value is a comma-separated list of fields to be returned in the response for each Application. The attributes listed will be the only ones returned in the response, with the exception of id, schemas, and meta, which are always returned for an Application.'
- in: query
name: excludedAttributes
schema:
type: string
example: features
description: 'The Application attributes to exclude frome the response. The query parameter value is a comma-separated list of fields to be excluded from the response for each Application. The attributes listed will be the only ones excluded frome the response, with the exception of id, schemas, and meta, which are always returned for an Application.'
responses:
'200':
description: Returns all SCIM Application resources.
content:
application/json:
schema:
properties:
totalResults:
description: Number of Application resources returned.
type: integer
example: '18,'
startIndex:
description: The starting index of the resource set list. Can be specified with startIndex query parameter.
type: integer
example: 1
schemas:
description: SCIM Schema used for response.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:api:messages:2.0:ListResponse'
Resources:
type: array
items:
properties:
id:
description: IdentityIQ id of the Application.
type: string
example: c0b4568a4fe7458c434ee77d1fbt156b
name:
description: Unique name for the Application. This name MUST be unique across the entire set of Applications.
type: string
example: Active Directory
descriptions:
description: A list of localized descriptions of the Application.
type: array
example:
- locale: en_US
value: The main Active_Directory domain data for the corporate network.
type:
description: The type of the Application.
type: string
example: Active Directory - Direct
features:
description: A list of features of the Application.
type: array
example:
- - DIRECT_PERMISSIONS
- NO_RANDOM_ACCESS
- DISCOVER_SCHEMA
owner:
description: The owner of the Application.
type: object
properties:
displayName:
description: Display name of the application owner.
type: string
example: Joe Smith
value:
description: id of the application owner.
type: string
example: c0b4568a4fe7458c434ee77d1fbt156b
$ref:
description: URI reference of the application owner resource.
type: string
example: 'http://localhost:8080/identityiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b'
applicationSchemas:
description: List of the Application Schemas.
type: object
properties:
value:
description: The urn of the Application Schema.
type: string
example: 'urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:Active Directory:account'
type:
description: 'The type of Application Schema (account, group, etc.).'
type: string
example: account
$ref:
description: The URI of the SCIM resource representing the Entitlement.
type: string
example: 'http://localhost:8080/identityiq/scim/v2/Schemas/urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:Active%20Directory:account'
meta:
description: Metadata of the SCIM resource.
properties:
created:
description: Datetime this Application was created.
type: string
format: date-time
example: '2022-02-11T01:34:04.074-05:00'
location:
description: The location of the SCIM resource.
type: string
example: 'http://localhost:8080/identityiq/scim/v2/Applications/c0b4568a4fe7458c434ee77d1fbt156b'
lastModified:
description: Datetime the Application was last modified.
type: string
format: date-time
example: '2022-02-11T01:08:45.866-05:00'
version:
description: The version of the SCIM resource.
type: string
example: W"1644561244074"
resourceType:
description: The SCIM resource type.
type: string
example: Application
schemas:
description: The schemas involved in the SCIM resource.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:schemas:sailpoint:1.0:Application'
application/scim+json:
schema:
properties:
totalResults:
description: Number of Application resources returned.
type: integer
example: '1500,'
startIndex:
description: The starting index of the resource set list. Can be specified with startIndex query parameter.
type: integer
example: 1
schemas:
description: SCIM Schema used for response.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:api:messages:2.0:ListResponse'
Resources:
description: The SCIM resources returned for this endpoint.
type: array
items:
properties:
id:
description: IdentityIQ id of the Application.
type: string
example: c0b4568a4fe7458c434ee77d1fbt156b
name:
description: Unique name for the Application. This name MUST be unique across the entire set of Applications.
type: string
example: Active Directory
descriptions:
description: A list of localized descriptions of the Application.
type: array
example:
- locale: en_US
value: The main Active_Directory domain data for the corporate network.
type:
description: The type of the Application.
type: string
example: Active Directory - Direct
features:
description: A list of features of the Application.
type: array
example:
- - DIRECT_PERMISSIONS
- NO_RANDOM_ACCESS
- DISCOVER_SCHEMA
owner:
description: The owner of the Application.
type: object
properties:
displayName:
description: Display name of the application owner.
type: string
example: Joe Smith
value:
description: id of the application owner.
type: string
example: c0b4568a4fe7458c434ee77d1fbt156b
$ref:
description: URI reference of the application owner resource.
type: string
example: 'http://localhost:8080/identityiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b'
applicationSchemas:
description: List of the Application Schemas.
type: object
properties:
value:
description: The urn of the Application Schema.
type: string
example: 'urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:Active Directory:account'
type:
description: 'The type of Application Schema (account, group, etc.).'
type: string
example: account
$ref:
description: The URI of the SCIM resource representing the Entitlement.
type: string
example: 'http://localhost:8080/identityiq/scim/v2/Schemas/urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:Active%20Directory:account'
meta:
description: Metadata of the SCIM resource.
properties:
created:
description: Datetime this Application was created.
type: string
format: date-time
example: '2022-02-11T01:34:04.074-05:00'
location:
description: The location of the SCIM resource.
type: string
example: 'http://localhost:8080/identityiq/scim/v2/Applications/c0b4568a4fe7458c434ee77d1fbt156b'
lastModified:
description: Datetime the Application was last modified.
type: string
format: date-time
example: '2022-02-11T01:08:45.866-05:00'
version:
description: The version of the SCIM resource.
type: string
example: W"1644561244074"
resourceType:
description: The SCIM resource type.
type: string
example: Application
schemas:
description: The schemas involved in the SCIM resource.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:schemas:sailpoint:1.0:Application'
'/scim/v2/Applications/{applicationId}':
get:
operationId: getApplication
tags:
- Applications
summary: Returns an Application resource based on id or name.
description: |
The Application resource with matching id or name is returned. Attributes to include in the response can be specified with the 'attributes' query parameter.
Attributes to exclude from the response can be specified with the 'excludedAttributes' query parameter.
The schema related to Application is:
- **urn:ietf:params:scim:schemas:sailpoint:1.0:Application.**
parameters:
- name: applicationId
in: path
schema:
type: string
example: 7f00000180281df7818028bfaae8035b
description: id or name of Application resource.
required: true
- in: query
name: attributes
schema:
type: string
example: 'name,type,features'
description: 'The Application attributes to include in the response. The query parameter value is a comma-separated list of fields to be returned in the response for each Application. The attributes listed will be the only ones returned in the response, with the exception of id, schemas, and meta, which are always returned for an Application.'
- in: query
name: excludedAttributes
schema:
type: string
example: features
description: 'The Application attributes to exclude frome the response. The query parameter value is a comma-separated list of fields to be excluded from the response for each Application. The attributes listed will be the only ones excluded frome the response, with the exception of id, schemas, and meta, which are always returned for an Application.'
responses:
'200':
description: Returns a single Application resource based on the id.
content:
application/json:
schema:
properties:
id:
description: IdentityIQ id of the Application.
type: string
example: c0b4568a4fe7458c434ee77d1fbt156b
name:
description: Unique name for the Application. This name MUST be unique across the entire set of Applications.
type: string
example: Active Directory
descriptions:
description: A list of localized descriptions of the Application.
type: array
example:
- locale: en_US
value: The main Active_Directory domain data for the corporate network.
type:
description: The type of the Application.
type: string
example: Active Directory - Direct
features:
description: A list of features of the Application.
type: array
example:
- - DIRECT_PERMISSIONS
- NO_RANDOM_ACCESS
- DISCOVER_SCHEMA
owner:
description: The owner of the Application.
type: object
properties:
displayName:
description: Display name of the application owner.
type: string
example: Joe Smith
value:
description: id of the application owner.
type: string
example: c0b4568a4fe7458c434ee77d1fbt156b
$ref:
description: URI reference of the application owner resource.
type: string
example: 'http://localhost:8080/identityiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b'
applicationSchemas:
description: List of the Application Schemas.
type: object
properties:
value:
description: The urn of the Application Schema.
type: string
example: 'urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:Active Directory:account'
type:
description: 'The type of Application Schema (account, group, etc.).'
type: string
example: account
$ref:
description: The URI of the SCIM resource representing the Entitlement.
type: string
example: 'http://localhost:8080/identityiq/scim/v2/Schemas/urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:Active%20Directory:account'
meta:
description: Metadata of the SCIM resource.
properties:
created:
description: Datetime this Application was created.
type: string
format: date-time
example: '2022-02-11T01:34:04.074-05:00'
location:
description: The location of the SCIM resource.
type: string
example: 'http://localhost:8080/identityiq/scim/v2/Applications/c0b4568a4fe7458c434ee77d1fbt156b'
lastModified:
description: Datetime the Application was last modified.
type: string
format: date-time
example: '2022-02-11T01:08:45.866-05:00'
version:
description: The version of the SCIM resource.
type: string
example: W"1644561244074"
resourceType:
description: The SCIM resource type.
type: string
example: Application
schemas:
description: The schemas involved in the SCIM resource.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:schemas:sailpoint:1.0:Application'
/scim/v2/CheckedPolicyViolations:
post:
operationId: checkPolicyViolations
tags:
- Checked Policy Violations
summary: 'This endpoint simulates provisioning a set of access items, and then checks against a set of policies to determine if granting the access items would cause creation of new policy violations.'
description: |
>This submits a set of access items to request and a set of policies to check after the access provisioning is simulated in order to determine if policy violations would be created by provisioning the access items. It receives a payload that includes:
>**An identity:** Used as the recipient for the access items on the simulation.
>**A provisioning plan:** To specify the changes to be simulatedly provisioned in the provided identity
>**A list of policies:** to check after the simulation of provisioning plan was applied to the identity in order to determine if the access granted in the simulation causes new policy violations.
>Optionally you can pass a list of attributes, as query params, to be included or excluded from the response, this setting is applicable only to top level attributes as defined in the schema ***urn:ietf:params:scim:schemas:sailpoint:1.0:CheckedPolicyViolation.***
>**Valid values**:
**- policies**
**- identity**
**- plan**
**- violations**
**- leftBundles**
**- rightBundles**
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
identity:
description: An identity for whom access is requested on the provisioning simulation
type: string
example:
identity: Ryan.Russell
plan:
description: A provisioning plan detailing the access to request on the simulation
type: object
properties:
value:
type: object
properties:
accounts:
type: array
items:
type: object
properties:
op:
description: The operation to perform on the provisioning.
type: string
example: Modify
instance:
type: string
example: 'null'
description: A particular instance to provision this access to
application:
type: string
example: Active_Directory
description: The application that owns the access items in the request
attributes:
type: array
items:
type: object
properties:
op:
description: The operation to perform on the access item.
type: string
example: Add
name:
description: The type of access item to provision.
type: string
example: groupmbr
value:
description: The name of the access item to provision.
type: string
example: UnixAdministration
type:
type: string
example: application/sailpoint.object.ProvisioningPlan+json
policies:
description: A list of policies to check for new policy violations on the access provisioned by the simulation.
type: array
items:
type: string
example:
- SOD Policy
- Entitlement Policy
- RandomPolicyNotExisting
responses:
'201':
description: Returns a list of violations based on simulated requested access
content:
application/json:
schema:
type: object
properties:
identity:
description: An identity for whom access was requested on the provisioning simulation
type: string
example:
identity: Ryan.Russell
meta:
type: object
properties:
resourceType:
description: ''
type: string
example: CheckedPolicyViolation
violations:
type: array
items:
properties:
entitlements:
description: An array of the entitlements used in the provisioning simulation.
type: array
items:
type: string
example:
- a2a
- a2b
- benefits
policyName:
description: The name of the policy that conflicted with the access items provisioned in the simulation causing policy violation.
type: string
example: SOD Policy
policyType:
description: The type of the policy that conflicted with the access items provisioned in the simulation causing policy violation(s).
type: string
example: SOD
description:
description: The description of the policy violation(s) caused by the access provisioned in the simulation.
type: string
example: Security design should not be combined with administrative permissions.
constraintName:
description: The specific constraint in the policy that conflicted with the access items provisioned in the simulation.
type: string
example: ' IT SOD-117'
leftBundles:
description: The left set of entitlements defined in the policy constraint in order to check against another set of entitlements for compliance.
type: array
items:
type: string
example:
- Security Architect - IT
rightBundles:
description: The right set of entitlements defined in the policy constraint in order to check against another set of entitlements for compliance.
type: array
items:
type: string
example:
- Unix Administrator - IT
schemas:
description: The SCIM schema for Checked Policy Violations.
type: array
items:
type: string
example: 'urn:ietf:params:scim:schemas:sailpoint:1.0:CheckedPolicyViolation'
policies:
description: The set of policies used to check for conflicting access in the provisioning simulation
type: array
items:
type: string
example:
- SOD Policy
- Entitlement Policy
- RandomPolicyNotExisting
plan:
description: A provisioning plan detailing the access to request on the simulation
type: object
properties:
value:
type: object
properties:
accounts:
type: array
items:
type: object
properties:
op:
description: The operation performed on the access in the provisioning simulation.
type: string
example: Modify
instance:
type: string
example: 'null'
description: A particular instance to provision this access to
application:
type: string
example: Active_Directory
description: The application that owns the access provisioned in the simulation.
attributes:
type: array
items:
type: object
properties:
op:
description: The operation performed on the access in the provisioning simulation.
type: string
example: Add
name:
description: The type of provisioned access.
type: string
example: groupmbr
value:
description: The name of the provisioned access items.
type: string
example: UnixAdministration
type:
type: string
example: application/sailpoint.object.ProvisioningPlan+json
parameters:
- in: query
name: attributes
schema:
type: string
description: A list of attributes to indicate what top level attributes to include in the response
- in: query
name: authnPassword
schema:
type: string
description: Password for authentication
- in: query
name: authnUsername
schema:
type: string
description: Username for authentication
- in: query
name: excludedAttributes
schema:
type: string
description: A list of attributes to indicate what top level attributes to exclude from the response
- in: query
name: lookupByName
schema:
type: boolean
description: 'This is not required in this endpoint, the returned object is a new PolicyViolation and not one returned from the persistence layer. This is inherited from the BaseSCIMResource and is used to override the default id based lookup, and use a name based lookup instead, if for any reason the artifact id is not present.'
example: false
/scim/v2/Entitlements:
get:
operationId: getEntitlements
tags:
- Entitlements
summary: Returns all Entitlement resources.
description: |
This endpoint returns all Entitlement resources.
Attributes to include in the response can be specified with the 'attributes' query parameter.
Attributes to exclude from the response can be specified with the 'excludedAttributes' query parameter.
The schemas related to Entitlements are:
- **urn:ietf:params:scim:schemas:sailpoint:1.0:Entitlement**
parameters:
- in: query
name: filter
schema:
type: string
example: displayableName eq "accessLog"
description: 'Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported.'
- in: query
name: sortBy
schema:
type: string
example: application
description: Allows sorting the results by a resource's attributes.
- in: query
name: sortOrder
schema:
type: string
default: ascending
example: descending
description: Determines what order to sort results in.
- in: query
name: startIndex
schema:
type: integer
example: 10
default: 1
description: Determines the starting index of the result set.
- in: query
name: count
schema:
type: integer
example: 10
default: 1000
description: Specifies the number of results per page.
- in: query
name: attributes
schema:
type: string
example: application
description: 'A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.'
- in: query
name: excludedAttributes
schema:
type: string
example: application
description: A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**
responses:
'200':
description: Returned all SCIM resources for this endpoint.
content:
application/json:
schema:
properties:
totalResults:
description: Number of resources returned for this endpoint.
type: integer
example: '1,'
startIndex:
description: The starting index of the resource set list. Can be specified with startIndex query parameter.
type: integer
example: 1
schemas:
description: SCIM Schema used for response.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:api:messages:2.0:ListResponse'
Resources:
type: array
items:
properties:
id:
description: Unique identifier of the Entitlement.
type: string
example: 7f00000180281df7818028bfb83204dc
descriptions:
description: A list of localized descriptions of the Entitlement.
type: object
properties:
locale:
description: The locale associated with this Entitlement description.
type: string
example: en_GB
value:
description: The description in localized form.
type: string
example: **AP_Logins** Target Friendly Description
displayName:
description: Displayable name of the Entitlement.
type: string
example: AP_Logins
type:
description: Type of the Entitlement.
type: string
example: Permission
application:
description: The corresponding Application object of the Entitlement.
type: array
items:
properties:
value:
description: The Application associated with the Entitlement.
type: string
example: 7f00000180281df7818028bfac5a0367
$ref:
description: The URI of the SCIM resource representating the Entitlement application.
type: string
example: 'http://localhost:8080/identityiq/scim/v2/Applications/7f00000180281df7818028bfed100826'
displayName:
description: The name of the Entitlement Application. OPTIONAL and READ-ONLY.
type: string
example: Oracle_DB_oasis
owner:
description: The owner of the Entitlement.
type: array
items:
properties:
value:
description: The id of the SCIM resource representing the Entitlement Owner.
type: string
example: 7f00000180281df7818028bfb0d103c7
$ref:
description: The URI of the SCIM resource representing the Entitlement Owner.
type: string
example: 'http://localhost:8080/identityiq/scim/v2/Users/7f00000180281df7818028bfb0d103c7'
displayName:
description: The displayName of the Entitlement Owner. OPTIONAL and READ-ONLY.
type: string
example: Debra Wood
requestable:
description: Flag to indicate this entitlement is requestable.
type: boolean
example: true
aggregated:
description: Flag to indicate this entitlement has been aggregated.
type: boolean
example: true
attribute:
description: Attribute of the Entitlement.
type: string
example: AP_Logins
value:
description: Attribute value of the Entitlement.
type: string
example: 'CN=AP_Logins,OU=Security,OU=Permissions,DC=test,DC=sailpoint,DC=com'
lastRefresh:
description: The DateTime when the Entitlement was refreshed.
type: string
format: date-time
example: '2022-04-14T10:48:01.907-05:00'
lastTargetAggregation:
description: The date aggregation was last targeted of the Entitlement.
type: string
format: date-time
example: '2022-04-14T10:48:01.907-05:00'
classifications:
description: Classifications of this Entitlement.
type: object
required:
- classification
properties:
source:
description: The source of the ObjectClassification.
type: string
example: UI
effective:
description: Flag indicating this is an effective Classification.
type: boolean
example: false
classification:
description: Classification of this object.
type: object
properties:
name:
description: The name of the classification.
type: string
example: ClassificationB
displayName:
description: The display name of the classification.
type: string
example: ClassB
origin:
description: The origin of the Classification.
type: string
example: PAMSource
type:
description: The type of the Classification.
type: string
example: Aggregation
meta:
type: object
properties:
created:
description: DateTime when the Entitlement was created.
type: string
format: date-time
example: '2022-04-14T10:44:54.834-05:00'
location:
description: URL to the Entitlement.
type: string
example: 'http://localhost:8080/identityiq/scim/v2/Entitlements/7f00000180281df7818028bfb83204dc'
lastModified:
description: DateTime of Entitlement last modification.
type: string
format: date-time
example: '2022-04-05T15:52:30.119-05:00'
version:
description: Entitlement version.
type: string
example: '"W"1649951094834"'
resourceType:
description: Resource type of the metadata subject.
type: string
example: Entitlement
schemas:
type: array
example:
- 'urn:ietf:params:scim:schemas:sailpoint:1.0:Entitlement'
entitleAuth:
description: This is an Extended Attribute from Managed Attribute used to describe the authorization level of an Entitlement.
type: string
example: Low
entDate:
description: This is an Extended Attribute from Managed Attribute. The Entitlement DateTime.
type: string
format: date-time
example: '2022-04-14T10:44:54.738-05:00'
active:
description: This is an Extended Attribute from Managed Attribute. Describes if an Entitlement is active.
type: boolean
example: false
rank:
description: This is an Extended Attribute from Managed Attribute.
type: integer
example: 3
rule:
description: This is an Extended Attribute from Managed Attribute. Used to specify a Rule object for the Entitlement.
type: string
example: APLogin-Contractors-Rule
reviewer:
description: This is an Extended Attribute from Managed Attribute. The Identity that reviewed the Entitlement.
type: object
properties:
displayName:
description: Display name of the Entitlement reviewer.
type: string
example: Dan Patrick
value:
description: id of the Entitlement reviewer.
type: string
example: c0b4568a4fe7458c434ee77f2fad267c
$ref:
description: URI reference of the Entitlement reviewer resource.
type: string
example: 'http://localhost:8080/identityiq/scim/v2/Users/c0b4568a4fe7458c434ee77f2fad267c'
email:
description: This is an Extended Attribute from Managed Attribute. Used to specify the Entitlement owner email.
type: string
example: dpatrick@demoexample.com
application/scim+json:
schema:
properties:
totalResults:
description: Number of Entitlement resources returned.
type: integer
example: '1500,'
startIndex:
description: The starting index of the resource set list. Can be specified with startIndex query parameter.
type: integer
example: 1
schemas:
description: SCIM Schema used for response.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:api:messages:2.0:ListResponse'
Resources:
description: The SCIM resources returned for this endpoint.
type: array
items:
properties:
id:
description: Unique identifier of the Entitlement.
type: string
example: 7f00000180281df7818028bfb83204dc
descriptions:
description: A list of localized descriptions of the Entitlement.
type: object
properties:
locale:
description: The locale associated with this Entitlement description.
type: string
example: en_GB
value:
description: The description in localized form.
type: string
example: **AP_Logins** Target Friendly Description
displayName:
description: Displayable name of the Entitlement.
type: string
example: AP_Logins
type:
description: Type of the Entitlement.
type: string
example: Permission
application:
description: The corresponding Application object of the Entitlement.
type: array
items:
properties:
value:
description: The Application associated with the Entitlement.
type: string
example: 7f00000180281df7818028bfac5a0367
$ref:
description: The URI of the SCIM resource representating the Entitlement application.
type: string
example: 'http://localhost:8080/identityiq/scim/v2/Applications/7f00000180281df7818028bfed100826'
displayName:
description: The name of the Entitlement Application. OPTIONAL and READ-ONLY.
type: string
example: Oracle_DB_oasis
owner:
description: The owner of the Entitlement.
type: array
items:
properties:
value:
description: The id of the SCIM resource representing the Entitlement Owner.
type: string
example: 7f00000180281df7818028bfb0d103c7
$ref:
description: The URI of the SCIM resource representing the Entitlement Owner.
type: string
example: 'http://localhost:8080/identityiq/scim/v2/Users/7f00000180281df7818028bfb0d103c7'
displayName:
description: The displayName of the Entitlement Owner. OPTIONAL and READ-ONLY.
type: string
example: Debra Wood
requestable:
description: Flag to indicate this entitlement is requestable.
type: boolean
example: true
aggregated:
description: Flag to indicate this entitlement has been aggregated.
type: boolean
example: true
attribute:
description: Attribute of the Entitlement.
type: string
example: AP_Logins
value:
description: Attribute value of the Entitlement.
type: string
example: 'CN=AP_Logins,OU=Security,OU=Permissions,DC=test,DC=sailpoint,DC=com'
lastRefresh:
description: The DateTime when the Entitlement was refreshed.
type: string
format: date-time
example: '2022-04-14T10:48:01.907-05:00'
lastTargetAggregation:
description: The date aggregation was last targeted of the Entitlement.
type: string
format: date-time
example: '2022-04-14T10:48:01.907-05:00'
classifications:
description: Classifications of this Entitlement.
type: object
required:
- classification
properties:
source:
description: The source of the ObjectClassification.
type: string
example: UI
effective:
description: Flag indicating this is an effective Classification.
type: boolean
example: false
classification:
description: Classification of this object.
type: object
properties:
name:
description: The name of the classification.
type: string
example: ClassificationB
displayName:
description: The display name of the classification.
type: string
example: ClassB
origin:
description: The origin of the Classification.
type: string
example: PAMSource
type:
description: The type of the Classification.
type: string
example: Aggregation
meta:
type: object
properties:
created:
description: DateTime when the Entitlement was created.
type: string
format: date-time
example: '2022-04-14T10:44:54.834-05:00'
location:
description: URL to the Entitlement.
type: string
example: 'http://localhost:8080/identityiq/scim/v2/Entitlements/7f00000180281df7818028bfb83204dc'
lastModified:
description: DateTime of Entitlement last modification.
type: string
format: date-time
example: '2022-04-05T15:52:30.119-05:00'
version:
description: Entitlement version.
type: string
example: '"W"1649951094834"'
resourceType:
description: Resource type of the metadata subject.
type: string
example: Entitlement
schemas:
type: array
example:
- 'urn:ietf:params:scim:schemas:sailpoint:1.0:Entitlement'
entitleAuth:
description: This is an Extended Attribute from Managed Attribute used to describe the authorization level of an Entitlement.
type: string
example: Low
entDate:
description: This is an Extended Attribute from Managed Attribute. The Entitlement DateTime.
type: string
format: date-time
example: '2022-04-14T10:44:54.738-05:00'
active:
description: This is an Extended Attribute from Managed Attribute. Describes if an Entitlement is active.
type: boolean
example: false
rank:
description: This is an Extended Attribute from Managed Attribute.
type: integer
example: 3
rule:
description: This is an Extended Attribute from Managed Attribute. Used to specify a Rule object for the Entitlement.
type: string
example: APLogin-Contractors-Rule
reviewer:
description: This is an Extended Attribute from Managed Attribute. The Identity that reviewed the Entitlement.
type: object
properties:
displayName:
description: Display name of the Entitlement reviewer.
type: string
example: Dan Patrick
value:
description: id of the Entitlement reviewer.
type: string
example: c0b4568a4fe7458c434ee77f2fad267c
$ref:
description: URI reference of the Entitlement reviewer resource.
type: string
example: 'http://localhost:8080/identityiq/scim/v2/Users/c0b4568a4fe7458c434ee77f2fad267c'
email:
description: This is an Extended Attribute from Managed Attribute. Used to specify the Entitlement owner email.
type: string
example: dpatrick@demoexample.com
'/scim/v2/Entitlements/{entitlementId}':
get:
operationId: getEntitlementById
tags:
- Entitlements
summary: Returns an Entitlement resource based on id.
description: |
The Entitlement resource with matching id is returned.
Attributes to include in the response can be specified with the attributes query parameter.
Attributes to exclude from the response can be specified with the excludedAttributes query parameter.
parameters:
- name: entitlementId
in: path
schema:
type: string
example: c0a8019c802d1e5a81802eb2b57e020f
description: id of Entitlement resource.
required: true
- in: query
name: attributes
schema:
type: string
example: application
description: 'A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.'
- in: query
name: excludedAttributes
schema:
type: string
example: 'name, application'
description: A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**
responses:
'200':
description: Returns a single Entitlement resource based on the id.
content:
application/json:
schema:
properties:
id:
description: Unique identifier of the Entitlement.
type: string
example: 7f00000180281df7818028bfb7d204c1
descriptions:
description: A list of localized descriptions of the Entitlement.
type: object
properties:
locale:
description: The locale associated with this Entitlement description.
type: string
example: en_US
value:
description: The description in localized form.
type: string
example: **Employee Database** target friendly description
displayableName:
description: Displayable name of the Entitlement.
type: string
example: a2a
type:
description: Type of the Entitlement.
type: string
example: group
application:
description: The corresponding Application object of the Entitlement.
type: array
items:
properties:
value:
description: The Application associated with the Entitlement.
type: string
example: 7f00000180281df7818028bfed100826
$ref:
description: The URI of the SCIM resource representating the Entitlement application.
type: string
example: 'http://localhost:8080/identityiq/scim/v2/Applications/7f00000180281df7818028bfed100826'
displayName:
description: The name of the Entitlement Application. OPTIONAL and READ-ONLY.
type: string
example: SAP
owner:
description: The owner of the Entitlement.
type: array
items:
properties:
value:
description: The id of the SCIM resource representing the Entitlement Owner.
type: string
example: 7f00000180281df7818028bfab930361
$ref:
description: The URI of the SCIM resource representing the Entitlement Owner.
type: string
example: 'http://localhost:8080/identityiq/scim/v2/Users/7f00000180281df7818028bfab930361'
displayName:
description: The displayName of the Entitlement Owner. OPTIONAL and READ-ONLY.
type: string
example: Mary Johnson
requestable:
description: Flag to indicate this entitlement is requestable.
type: boolean
example: true
aggregated:
description: Flag to indicate this entitlement has been aggregated.
type: boolean
example: true
attribute:
description: Attribute of the Entitlement.
type: string
example: memberOf
value:
description: Attribute value of the Entitlement.
type: string
example: 'CN=a2a,OU=HierarchicalGroups,OU=DemoData,DC=test,DC=sailpoint,DC=com'
lastRefresh:
description: The DateTime when the Entitlement was refreshed.
format: date-time
type: string
example: '2022-04-14T10:48:01.907-05:00'
lastTargetAggregation:
description: The date aggregation was last targeted of the Entitlement.
type: string
format: date-time
example: '2022-04-14T10:48:01.907-05:00'
classifications:
description: Classifications of this Entitlement.
type: object
required:
- classification
properties:
source:
description: The source of the ObjectClassification.
type: string
example: UI
effective:
description: Flag indicating this is an effective Classification.
type: boolean
example: false
classification:
description: Classification of this object.
type: object
properties:
name:
description: The name of the Classification.
type: string
example: ClassificationA
displayName:
description: The displayName of the Classification.
type: string
example: ClassA
origin:
description: The origin of the Classification.
type: string
example: FAM Aggregation
type:
description: The type of the Classification.
type: string
example: Aggregation
meta:
type: object
properties:
created:
description: DateTime when the Entitlement was created.
type: string
format: date-time
example: '2022-04-05T15:52:30.090-05:00'
location:
description: URL to the Entitlement.
type: string
example: 'http://localhost:8080/identityiq/scim/v2/Entitlements/c0a8019c7ffa186e817ffb80170a0195'
lastModified:
description: DateTime of Entitlement last modification.
type: string
format: date-time
example: '2022-04-05T15:52:30.119-05:00'
version:
description: Entitlement version.
type: string
example: '"W"1649191950119"'
resourceType:
description: Resource type of the metadata subject.
type: string
example: Entitlement
schemas:
type: array
example:
- 'urn:ietf:params:scim:schemas:sailpoint:1.0:Entitlement'
entitleAuth:
description: This is an Extended Attribute from Managed Attribute used to describe the authorization level of an Entitlement.
type: string
example: None
entDate:
description: This is an Extended Attribute from Managed Attribute. The Entitlement DateTime.
type: string
format: date-time
example: '2022-04-14T10:44:54.738-05:00'
active:
description: This is an Extended Attribute from Managed Attribute. Describes if an Entitlement is active.
type: boolean
example: false
rank:
description: This is an Extended Attribute from Managed Attribute.
type: integer
example: 3
rule:
description: This is an Extended Attribute from Managed Attribute. Used to specify a Rule object for the Entitlement.
type: string
example: APLogin-Contractors-Rule
reviewer:
description: This is an Extended Attribute from Managed Attribute. The Identity that reviewed the Entitlement.
type: object
properties:
displayName:
description: Display name of the Entitlement reviewer.
type: string
example: Caroline Lee
value:
description: id of the Entitlement reviewer.
type: string
example: c0b4568a4fe7458c434ee77f2fad267c
$ref:
description: URI reference of the Entitlement reviewer resource.
type: string
example: 'http://localhost:8080/identityiq/scim/v2/Users/c0b4568a4fe7458c434ee77f2fad267c'
emails:
description: This is an Extended Attribute from Managed Attribute. Used to specify the Entitlement owner email.
type: string
example: clee@demoexample.com
/scim/v2/LaunchedWorkflows:
get:
operationId: LaunchedWorkflowsGet
tags:
- LaunchedWorkflows
summary: Returns all LaunchedWorkflow resources.
description: |
This endpoint returns all LaunchedWorkflow resources.
Attributes to include in the response can be specified with the 'attributes' query parameter.
Attributes to exclude from the response can be specified with the 'excludedAttributes' query parameter.
The schema related to LaunchedWorkflow is:
- **urn:ietf:params:scim:schemas:sailpoint:1.0:LaunchedWorkflow**
parameters:
- in: query
name: filter
schema:
type: string
example: 'completed eq "2022-05-03T16:40:34.271-05:00"'
description: 'Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported.'
- in: query
name: sortBy
schema:
type: string
example: application
description: Allows sorting the results by a resource's attributes.
- in: query
name: sortOrder
schema:
type: string
default: ascending
example: descending
description: Determines what order to sort results in.
- in: query
name: startIndex
schema:
type: integer
example: 10
default: 1
description: Determines the starting index of the result set.
- in: query
name: count
schema:
type: integer
example: 10
default: 1000
description: Specifies the number of results per page.
- in: query
name: attributes
schema:
type: string
example: 'name, expiration'
description: 'A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.'
- in: query
name: excludedAttributes
schema:
type: string
example: identityRequestId
description: A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**
responses:
'200':
description: Returned all SCIM resources for this endpoint.
**LaunchedWorkflow responses include attributes from the TaskResult related to the Workflow execution.**
content:
application/json:
schema:
properties:
totalResults:
description: Number of resources returned for this endpoint
type: integer
example: '1,'
startIndex:
description: The starting index of the resource set list. Can be specified with startIndex query parameter.
type: integer
example: 1
schemas:
description: SCIM Schema used for response.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:api:messages:2.0:ListResponse'
Resources:
type: array
items:
properties:
partitioned:
description: Flag to indicate this TaskResult is partitioned. (From the TaskResult used to launch the Workflow).
type: boolean
example: true
completed:
type: string
format: date-time
description: The completed DateTime of the TaskResult. (From the TaskResult used to launch the Workflow).
example: '2022-04-14T10:45:26.098-05:00'
type:
description: Type of the TaskResult. (From the TaskResult used to launch the Workflow).
type: string
example: Workflow
launched:
type: string
format: date-time
description: The launched DateTime of the TaskResult. (From the TaskResult used to launch the Workflow).
example: '2022-04-14T10:45:26.114-05:00'
pendingSignOffs:
description: The number of pending signoffs of this TaskResult. (From the TaskResult used to launch the Workflow).
type: integer
example: 2
workflowName:
description: Name of the Workflow to launch.
type: string
example: Update Identity Adam.Kennedy AccessRequest
identityRequestId:
description: Id representing the identity request.
type: string
example: '0000000001'
workflowCaseId:
description: Id representing the workflow case (a running instance of a workflow).
type: string
example: c0a8019c808b1baa81808bde2c2201b3
workflowProcessId:
type: string
description: Id representing the workflow monitoring process log.
example: 7f000001806719888180675c8f8a225g
retries:
description: The number of retries performed during the execution of provisioning activities.
type: integer
example: 1
approvalSet:
description: XML representation of approvals.
type: string
example: 'example:
Attributes to include in the response can be specified with the attributes query parameter.
Attributes to exclude from the response can be specified with the excludedAttributes query parameter.
The schema related to LaunchedWorkflow is:
- **urn:ietf:params:scim:schemas:sailpoint:1.0:LaunchedWorkflow**
parameters:
- name: launchedWorkflowId
in: path
schema:
type: string
example: c0a8019c802d1e5a81802eb2b57e020f
description: id of LaunchedWorkflow resource.
required: true
- in: query
name: attributes
schema:
type: string
example: expiration
description: 'A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.'
- in: query
name: excludedAttributes
schema:
type: string
example: names
description: A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**
responses:
'200':
description: Returns a single LaunchedWorkflow resource based on the id.
**LaunchedWorkflow responses include attributes from the TaskResult related to the Workflow execution.**
content:
application/json:
schema:
properties:
partitioned:
description: Flag to indicate this TaskResult is partitioned. (From the TaskResult used to launch the Workflow).
type: boolean
example: true
completed:
type: string
format: date-time
description: The completed DateTime of the TaskResult. (From the TaskResult used to launch the Workflow).
example: '2022-04-14T10:45:26.098-05:00'
type:
description: Type of the TaskResult. (From the TaskResult used to launch the Workflow).
type: string
example: Workflow
launched:
type: string
format: date-time
description: The launched DateTime of the TaskResult. (From the TaskResult used to launch the Workflow).
example: '2022-04-14T10:45:26.114-05:00'
pendingSignOffs:
description: The number of pending signoffs of this TaskResult. (From the TaskResult used to launch the Workflow).
type: integer
example: 2
workflowName:
description: Name of the Workflow to launch.
type: string
example: Update Account Group a2a
identityRequestId:
description: Id representing the identity request.
type: string
example: '0000000002'
workflowCaseId:
description: Id representing the workflow case (a running instance of a workflow).
type: string
example: 7f000001806719888180675c8f8a016a
workflowProcessId:
type: string
description: Id representing the workflow monitoring process log.
example: 7f000001806719888180675c8f8a0017b
retries:
description: The number of retries performed during the execution of provisioning activities.
type: integer
example: 1
approvalSet:
description: XML representation of approvals.
type: string
example: 'example:
Attributes to include in the response can be specified with the attributes query parameter.
Attributes to exclude from the response can be specified with the excludedAttributes query parameter.
The schema related to ObjectConfig is:
- **urn:ietf:params:scim:schemas:sailpoint:1.0:ObjectConfig**.
parameters:
- in: query
name: filter
schema:
type: string
example: name eq "identity"
description: 'Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported.'
- in: query
name: lookupByName
schema:
type: boolean
default: false
example: true
description: (OPTIONAL) Set to true if the ObjectConfig name is passed instead of the ObjectConfig id.
- in: query
name: sortBy
schema:
type: string
example: name
description: Allows sorting the results by a resource's attributes.
- in: query
name: sortOrder
schema:
type: string
default: ascending
example: descending
description: Determines what order to sort results in.
- in: query
name: startIndex
schema:
type: integer
example: 10
default: 1
description: Determines the starting index of the result set.
- in: query
name: count
schema:
type: integer
example: 10
default: 1000
description: Specifies the number of results per page.
- in: query
name: attributes
schema:
type: string
example: name
description: 'A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.'
- in: query
name: excludedAttributes
schema:
type: string
example: 'name, objectAttributes'
description: A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**
responses:
'200':
description: Returned all SCIM resources for this endpoint.
content:
application/json:
schema:
properties:
totalResults:
description: Number of resources returned for this endpoint
type: integer
example: '1,'
startIndex:
description: The starting index of the resource set list. Can be specified with startIndex query parameter.
type: integer
example: 1
schemas:
description: SCIM Schema used for response.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:api:messages:2.0:ListResponse'
Resources:
type: array
items:
properties:
id:
description: Unique identifier of the ObjectConfig.
type: string
example: c0a8019c7fe11678817fe18984351477
name:
description: Name of the ObjectConfig.
type: string
example: Link
objectAttributes:
description: A list of attributes of the ObjectConfig.
type: array
items:
properties:
name:
description: The object attribute name.
type: string
example: inactive
displayName:
description: The display name of the object attribute.
type: string
example: attr_demoInactive
type:
description: The type of the object attribute.
type: string
example: boolean
multi:
description: A Boolean value indicating this is a multi-valued attribute.
type: boolean
example: false
defaultValue:
description: The default value of the object attribute.
type: string
example: 'false'
system:
description: A Boolean value indicating this is a system attribute that does not have a source and is not configurable.
type: boolean
example: true
standard:
description: 'A Boolean value indicating this is a standard attribute (i.e. manager, email, firstname, lastname).'
type: boolean
example: false
extendedNumber:
description: Integer value of the extended attribute column number in the database schema.
type: integer
example: 1
namedColumn:
description: A Boolean value indicating this attribute has a named column in the database schema.
type: boolean
example: false
ruleName:
description: Rule used to derive the value. Usually specified when there are no attributeSources defined.
type: string
example: lastLoginToDateRule
groupFactory:
description: A Boolean value indicating this attribute can be used in a group factory. Identity attributes only.
type: boolean
example: true
editMode:
description: Enumeration indicating whether this attribute allows modification.
type: string
enum:
- READONLY
- PERMANENT
- UNTILFEEDVALUECHANGES
example: READONLY
attributeSources:
description: Sources of values for this atribute. Identity attributes only.
type: array
items:
properties:
name:
description: The name of the attribute on the application.
type: string
example: app1_inactive
key:
description: Derived identifier for this source.
type: string
example: 'Active_Directory:app1_inactive'
instance:
description: Optional instance name for template applications.
type: string
example: test-environment
ruleName:
description: Rule used to derive the value.
type: string
example: attributeSource-aws-S3-rule
attributeTargets:
description: Targets of this attribute that should receive the value upon attribute synchronization. Identity attributes only.
type: array
items:
properties:
name:
description: The name of the attribute on the application.
type: string
example: app2_active
key:
description: Derived identifier for this target.
type: string
example: 'Composite_ERP_Global_Platform:app2_inactive'
instance:
description: Optional instance name for template applications.
type: string
example: continuous-integration-environment1
ruleName:
description: Rule used to derive the value.
type: string
example: attributeTarget-aws-S3-rule
provisionAllAccount:
description: Return whether to provision all accounts if an identity has multiple accounts on the target application. Identity attributes only.
type: boolean
example: false
meta:
description: Metadata for the ObjectConfig
type: array
items:
properties:
created:
description: Datetime when the ObjectConfig was created
type: string
example: '2022-03-31T14:52:40.245-05:00'
location:
description: URL to the ObjectConfig
type: string
example: 'http://localhost:8080/identityiq/scim/v2/ObjectConfig/7f00000180281df7818028be62ef00e9'
lastModified:
description: Datetime of ObjectConfig last modification
type: string
example: '2022-03-31T14:52:40.265-05:00'
version:
description: ObjectConfig version
type: string
example: '"W"1649951092552"'
resourceType:
description: Resource type of the metadata subject
type: string
example: ObjectConfig
application/scim+json:
schema:
properties:
totalResults:
description: Number of ObjectConfig resources returned.
type: integer
example: '1500,'
startIndex:
description: The starting index of the resource set list. Can be specified with startIndex query parameter.
type: integer
example: 1
schemas:
description: SCIM Schema used for response.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:api:messages:2.0:ListResponse'
Resources:
description: The SCIM resources returned for this endpoint.
type: array
items:
properties:
id:
description: Unique identifier of the ObjectConfig.
type: string
example: c0a8019c7fe11678817fe18984351477
name:
description: Name of the ObjectConfig.
type: string
example: Link
objectAttributes:
description: A list of attributes of the ObjectConfig.
type: array
items:
properties:
name:
description: The object attribute name.
type: string
example: inactive
displayName:
description: The display name of the object attribute.
type: string
example: attr_demoInactive
type:
description: The type of the object attribute.
type: string
example: boolean
multi:
description: A Boolean value indicating this is a multi-valued attribute.
type: boolean
example: false
defaultValue:
description: The default value of the object attribute.
type: string
example: 'false'
system:
description: A Boolean value indicating this is a system attribute that does not have a source and is not configurable.
type: boolean
example: true
standard:
description: 'A Boolean value indicating this is a standard attribute (i.e. manager, email, firstname, lastname).'
type: boolean
example: false
extendedNumber:
description: Integer value of the extended attribute column number in the database schema.
type: integer
example: 1
namedColumn:
description: A Boolean value indicating this attribute has a named column in the database schema.
type: boolean
example: false
ruleName:
description: Rule used to derive the value. Usually specified when there are no attributeSources defined.
type: string
example: lastLoginToDateRule
groupFactory:
description: A Boolean value indicating this attribute can be used in a group factory. Identity attributes only.
type: boolean
example: true
editMode:
description: Enumeration indicating whether this attribute allows modification.
type: string
enum:
- READONLY
- PERMANENT
- UNTILFEEDVALUECHANGES
example: READONLY
attributeSources:
description: Sources of values for this atribute. Identity attributes only.
type: array
items:
properties:
name:
description: The name of the attribute on the application.
type: string
example: app1_inactive
key:
description: Derived identifier for this source.
type: string
example: 'Active_Directory:app1_inactive'
instance:
description: Optional instance name for template applications.
type: string
example: test-environment
ruleName:
description: Rule used to derive the value.
type: string
example: attributeSource-aws-S3-rule
attributeTargets:
description: Targets of this attribute that should receive the value upon attribute synchronization. Identity attributes only.
type: array
items:
properties:
name:
description: The name of the attribute on the application.
type: string
example: app2_active
key:
description: Derived identifier for this target.
type: string
example: 'Composite_ERP_Global_Platform:app2_inactive'
instance:
description: Optional instance name for template applications.
type: string
example: continuous-integration-environment1
ruleName:
description: Rule used to derive the value.
type: string
example: attributeTarget-aws-S3-rule
provisionAllAccount:
description: Return whether to provision all accounts if an identity has multiple accounts on the target application. Identity attributes only.
type: boolean
example: false
meta:
description: Metadata for the ObjectConfig
type: array
items:
properties:
created:
description: Datetime when the ObjectConfig was created
type: string
example: '2022-03-31T14:52:40.245-05:00'
location:
description: URL to the ObjectConfig
type: string
example: 'http://localhost:8080/identityiq/scim/v2/ObjectConfig/7f00000180281df7818028be62ef00e9'
lastModified:
description: Datetime of ObjectConfig last modification
type: string
example: '2022-03-31T14:52:40.265-05:00'
version:
description: ObjectConfig version
type: string
example: '"W"1649951092552"'
resourceType:
description: Resource type of the metadata subject
type: string
example: ObjectConfig
'/scim/v2/ObjectConfigs/{objectConfigNameOrId}':
get:
operationId: getObjectConfigById
tags:
- Object Configuration
summary: Returns an ObjectConfig resource based on its name or id.
description: |
The ObjectConfig resource with matching name or id is returned.
Attributes to include in the response can be specified with the 'attributes' query parameter.
Attributes to exclude from the response can be specified with the 'excludedAttributes' query parameter.
The schema related to ObjectConfig is:
- **urn:ietf:params:scim:schemas:sailpoint:1.0:ObjectConfig**
parameters:
- name: objectConfigId
in: path
schema:
type: string
example: 7f00000180281df7818028be62e500e8
description: id of ObjectConfig resource.
required: true
- in: query
name: attributes
schema:
type: string
example: objectAttributes
description: 'A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.'
- in: query
name: excludedAttributes
schema:
type: string
example: name
description: A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**
responses:
'200':
description: Returns a single ObjectConfig resource based on its name or id.
content:
application/json:
schema:
properties:
id:
description: Unique identifier of the ObjectConfig.
type: string
example: 7f00000180281df7818028be63aa00ef
name:
description: Name of the ObjectConfig.
type: string
example: Bundle
objectAttributes:
description: A list of attributes of the ObjectConfig.
type: array
items:
properties:
name:
description: The object attribute name.
type: string
example: StringAttr
displayName:
description: The display name of the object attribute.
type: string
example: attr_demoString
type:
description: The type of the object attribute.
type: string
example: string
multi:
description: A Boolean value indicating this is a multi-valued attribute.
type: boolean
example: false
defaultValue:
description: The default value of the object attribute.
type: string
example: None
system:
description: A Boolean value indicating this is a system attribute that does not have a source and is not configurable.
type: boolean
example: false
standard:
description: 'A Boolean value indicating this is a standard attribute (i.e. manager, email, firstname, lastname).'
type: boolean
example: false
extendedNumber:
description: Integer value of the extended attribute column number in the database schema.
type: integer
example: 2
namedColumn:
description: A Boolean value indicating this attribute has a named column in the database schema.
type: boolean
example: false
ruleName:
description: Rule used to derive the value. Usually specified when there are no attributeSources defined.
type: string
example: lastLoginToDate
groupFactory:
description: A Boolean value indicating this attribute can be used in a group factory. Identity attributes only.
type: boolean
example: true
editMode:
description: Enumeration indicating whether this attribute allows modification.
type: string
enum:
- READONLY
- PERMANENT
- UNTILFEEDVALUECHANGES
example: READONLY
attributeSources:
description: Sources of values for this atribute. Identity attributes only.
type: array
items:
properties:
name:
description: The name of the attribute on the application.
type: string
example: lastName
key:
description: Derived identifier for this source.
type: string
example: 'testInstancesApplication/inst2:lastName'
instance:
description: Optional instance name for template applications.
type: string
example: inst2
ruleName:
description: Rule used to derive the value.
type: string
example: Identity Attribute Rule - Type
attributeTargets:
description: Targets of this attribute that should receive the value upon attribute synchronization. Identity attributes only.
type: array
items:
properties:
name:
description: The name of the attribute on the application.
type: string
example: app2_active
key:
description: Derived identifier for this target.
type: string
example: 'Composite_ERP_Global_Platform:app2_inactive'
instance:
description: Optional instance name for template applications.
type: string
example: continuous-integration-environment1
ruleName:
description: Rule used to derive the value.
type: string
example: attributeTarget-aws-S3-rule
provisionAllAccount:
description: Return whether to provision all accounts if an identity has multiple accounts on the target application. Identity attributes only.
type: boolean
example: false
meta:
description: Metadata for the ObjectConfig
type: array
items:
properties:
created:
description: Datetime when the ObjectConfig was created
type: string
example: '2022-03-31T14:52:40.245-05:00'
location:
description: URL to the ObjectConfig
type: string
example: 'http://localhost:8080/identityiq/scim/v2/ObjectConfig/7f00000180281df7818028be62ef00e9'
lastModified:
description: Datetime of ObjectConfig last modification
type: string
example: '2022-03-31T14:52:40.265-05:00'
version:
description: ObjectConfig version
type: string
example: '"W"1649951092552"'
resourceType:
description: Resource type of the metadata subject
type: string
example: ObjectConfig
/scim/v2/PolicyViolations:
get:
operationId: getPolicyViolations
tags:
- Policy Violations
summary: Returns all PolicyViolation resources.
description: This endpoint returns all PolicyViolation resources.
parameters:
- in: query
name: filter
schema:
type: string
example: constraintName eq "Mock Constraint"
description: 'Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported.'
- in: query
name: sortBy
schema:
type: string
example: constraintName
description: Allows sorting the results by a resource's attributes.
- in: query
name: sortOrder
schema:
type: string
example: descending
default: ascending
description: Determines what order to sort results in.
- in: query
name: startIndex
schema:
type: integer
example: 2313
default: 1
description: Determines the starting index of the result set.
- in: query
name: count
schema:
type: integer
example: 10
default: 1000
description: Specifies the number of results per page.
- in: query
name: attributes
schema:
type: string
example: 'policyName,constraintName'
description: 'A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.'
- in: query
name: excludedAttributes
schema:
type: string
example: 'policyName,constraintName'
description: A comma-separated list of attributes to exclude from the response. *Some attributes cannot be excluded.*
responses:
'200':
description: Returns all PolicyViolation resources.
content:
application/json:
schema:
properties:
totalResults:
description: Number of PolicyViolation resources returned
type: integer
example: '18,'
startIndex:
description: The starting index of the resource set list. Can be specified with startIndex query parameter.
type: integer
example: 1
schemas:
description: SCIM Schema used for response.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:api:messages:2.0:ListResponse'
Resources:
type: array
items:
properties:
id:
description: IdentityIQ id of the PolicyViolation.
type: string
example: c0b4568a4fe7458c434ee77d1fbt156b
policyName:
description: Name of the Policy this PolicyViolation is associated with.
type: string
example: Entitlement Policy with Details
constraintName:
description: Name of the Constraint this PolicyViolation is associated with.
type: string
example: Entitlement Policy with Details
identity:
description: The Identity (User) that caused the PolicyViolation.
type: object
properties:
displayName:
description: Display name of the Identity that caused the PolicyViolation.
type: string
example: Bob Smith
value:
description: The id of the Identity which caused the PolicyViolation.
type: string
example: c0a7778b7ef71e79817ee74e6a1f0444
$ref:
description: URI reference to the Identity (User).
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444'
owner:
description: The User that owns the Policy.
type: object
properties:
displayName:
description: Display name of the Policy owner.
type: string
example: Bob Smith
value:
description: The id of the Policy owner.
type: string
example: c0a7778b7ef71e79817ee74e6a1f0444
$ref:
description: URI reference to the Policy owner.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444'
description:
description: Description of the PolicyViolation.
type: string
example: Production and development systems should not be available to one person.
status:
description: 'Status of the PolicyViolation. This can be Open, Mitigated, Remediated, or Delegated.'
type: string
example: Open
meta:
description: Metadata of the resource.
properties:
created:
description: Datetime this Resource was created.
type: string
format: date-time
example: '2022-02-11T01:34:04.074-05:00'
location:
description: The location of the resource.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b'
lastModified:
description: Datetime the resource was last modified.
type: string
format: date-time
example: '2022-02-11T01:08:45.866-05:00'
version:
description: The version of the resource.
type: string
example: W/"1644561244074"
resourceType:
description: The SCIM resource type.
type: string
example: PolicyViolation
schemas:
description: The schemas involved in the SCIM resource.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:schemas:sailpoint:1.0:PolicyViolation'
application/scim+json:
schema:
properties:
totalResults:
description: Number of PolicyViolation resources returned.
type: integer
example: '1500,'
startIndex:
description: The starting index of the resource set list. Can be specified with startIndex query parameter.
type: integer
example: 1
schemas:
description: SCIM Schema used for response.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:api:messages:2.0:ListResponse'
Resources:
description: The SCIM resources returned for this endpoint.
type: array
items:
properties:
id:
description: IdentityIQ id of the PolicyViolation.
type: string
example: c0b4568a4fe7458c434ee77d1fbt156b
policyName:
description: Name of the Policy this PolicyViolation is associated with.
type: string
example: Entitlement Policy with Details
constraintName:
description: Name of the Constraint this PolicyViolation is associated with.
type: string
example: Entitlement Policy with Details
identity:
description: The Identity (User) that caused the PolicyViolation.
type: object
properties:
displayName:
description: Display name of the Identity that caused the PolicyViolation.
type: string
example: Bob Smith
value:
description: The id of the Identity which caused the PolicyViolation.
type: string
example: c0a7778b7ef71e79817ee74e6a1f0444
$ref:
description: URI reference to the Identity (User).
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444'
owner:
description: The User that owns the Policy.
type: object
properties:
displayName:
description: Display name of the Policy owner.
type: string
example: Bob Smith
value:
description: The id of the Policy owner.
type: string
example: c0a7778b7ef71e79817ee74e6a1f0444
$ref:
description: URI reference to the Policy owner.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444'
description:
description: Description of the PolicyViolation.
type: string
example: Production and development systems should not be available to one person.
status:
description: 'Status of the PolicyViolation. This can be Open, Mitigated, Remediated, or Delegated.'
type: string
example: Open
meta:
description: Metadata of the resource.
properties:
created:
description: Datetime this Resource was created.
type: string
format: date-time
example: '2022-02-11T01:34:04.074-05:00'
location:
description: The location of the resource.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b'
lastModified:
description: Datetime the resource was last modified.
type: string
format: date-time
example: '2022-02-11T01:08:45.866-05:00'
version:
description: The version of the resource.
type: string
example: W/"1644561244074"
resourceType:
description: The SCIM resource type.
type: string
example: PolicyViolation
schemas:
description: The schemas involved in the SCIM resource.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:schemas:sailpoint:1.0:PolicyViolation'
'/scim/v2/PolicyViolations/{policyViolationId}':
get:
operationId: getPolicyViolationById
tags:
- Policy Violations
summary: Returns a PolicyViolation resource based on id.
description: The PolicyViolation resource with matching id is returned.
parameters:
- name: policyViolationId
in: path
schema:
type: string
description: The id of the PolicyViolation.
required: true
- in: query
name: attributes
schema:
type: string
example: 'policyName,constraintName'
description: 'A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.'
- in: query
name: excludedAttributes
schema:
type: string
example: 'policyName,constraintName'
description: A comma-separated list of attributes to exclude from the response. *Some attributes cannot be excluded.*
responses:
'200':
description: Returns a PolicyViolation resource based on the id.
content:
application/json:
schema:
properties:
id:
description: IdentityIQ id of the PolicyViolation.
type: string
example: c0b4568a4fe7458c434ee77d1fbt156b
policyName:
description: Name of the Policy this PolicyViolation is associated with.
type: string
example: Entitlement Policy with Details
constraintName:
description: Name of the Constraint this PolicyViolation is associated with.
type: string
example: Entitlement Policy with Details
identity:
description: The Identity (User) that caused the PolicyViolation.
type: object
properties:
displayName:
description: Display name of the Identity that caused the PolicyViolation.
type: string
example: Bob Smith
value:
description: The id of the Identity which caused the PolicyViolation.
type: string
example: c0a7778b7ef71e79817ee74e6a1f0444
$ref:
description: URI reference to the Identity (User).
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444'
owner:
description: The User that owns the Policy.
type: object
properties:
displayName:
description: Display name of the Policy owner.
type: string
example: Bob Smith
value:
description: The id of the Policy owner.
type: string
example: c0a7778b7ef71e79817ee74e6a1f0444
$ref:
description: URI reference to the Policy owner.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444'
description:
description: Description of the PolicyViolation.
type: string
example: Production and development systems should not be available to one person.
status:
description: 'Status of the PolicyViolation. This can be Open, Mitigated, Remediated, or Delegated.'
type: string
example: Open
meta:
description: Metadata of the resource.
properties:
created:
description: Datetime this Resource was created.
type: string
format: date-time
example: '2022-02-11T01:34:04.074-05:00'
location:
description: The location of the resource.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b'
lastModified:
description: Datetime the resource was last modified.
type: string
format: date-time
example: '2022-02-11T01:08:45.866-05:00'
version:
description: The version of the resource.
type: string
example: W/"1644561244074"
resourceType:
description: The SCIM resource type.
type: string
example: PolicyViolation
schemas:
description: The schemas involved in the SCIM resource.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:schemas:sailpoint:1.0:PolicyViolation'
application/scim+json:
schema:
properties:
id:
description: IdentityIQ id of the PolicyViolation.
type: string
example: c0b4568a4fe7458c434ee77d1fbt156b
policyName:
description: Name of the Policy this PolicyViolation is associated with.
type: string
example: Entitlement Policy with Details
constraintName:
description: Name of the Constraint this PolicyViolation is associated with.
type: string
example: Entitlement Policy with Details
identity:
description: The Identity (User) that caused the PolicyViolation.
type: object
properties:
displayName:
description: Display name of the Identity that caused the PolicyViolation.
type: string
example: Bob Smith
value:
description: The id of the Identity which caused the PolicyViolation.
type: string
example: c0a7778b7ef71e79817ee74e6a1f0444
$ref:
description: URI reference to the Identity (User).
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444'
owner:
description: The User that owns the Policy.
type: object
properties:
displayName:
description: Display name of the Policy owner.
type: string
example: Bob Smith
value:
description: The id of the Policy owner.
type: string
example: c0a7778b7ef71e79817ee74e6a1f0444
$ref:
description: URI reference to the Policy owner.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444'
description:
description: Description of the PolicyViolation.
type: string
example: Production and development systems should not be available to one person.
status:
description: 'Status of the PolicyViolation. This can be Open, Mitigated, Remediated, or Delegated.'
type: string
example: Open
meta:
description: Metadata of the resource.
properties:
created:
description: Datetime this Resource was created.
type: string
format: date-time
example: '2022-02-11T01:34:04.074-05:00'
location:
description: The location of the resource.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b'
lastModified:
description: Datetime the resource was last modified.
type: string
format: date-time
example: '2022-02-11T01:08:45.866-05:00'
version:
description: The version of the resource.
type: string
example: W/"1644561244074"
resourceType:
description: The SCIM resource type.
type: string
example: PolicyViolation
schemas:
description: The schemas involved in the SCIM resource.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:schemas:sailpoint:1.0:PolicyViolation'
/scim/v2/ResourceTypes:
get:
operationId: getResourceTypes
tags:
- ResourceTypes
summary: Returns all ResourceType resources.
description: 'All ResourceType resources are listed in the response. The common fields for each ResourceType entry are ''endpoint'', ''id'', ''name'', ''description'', ''schema'' and ''schemaExtensions''.'
responses:
'200':
description: Returns all ResourceType resources.
content:
application/json:
schema:
properties:
totalResults:
description: Number of ResourceType resources returned.
type: integer
example: 18
schemas:
description: The ResourceTypes type represented by URN used for this response.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:api:messages:2.0:ListResponse'
Resources:
type: array
items:
type: object
properties:
id:
description: ID of the ResourceType.
type: string
example: User
name:
description: Name of the ResourceType.
type: string
example: User
endpoint:
description: The ResourceType's HTTP addressable endpoint relative to the Base URL.
type: string
example: /Applications
description:
description: Description of the ResourceType.
type: string
example: User Account.
schema:
description: The primary/base schema URI of the ResourceType.
type: string
example: 'urn:ietf:params:scim:schemas:sailpoint:1.0:User'
schemaExtensions:
description: A list of URIs of the ResourceType's schema extensions.
type: array
items:
example:
- schema: 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User'
required: true
- schema: 'urn:ietf:params:scim:schemas:sailpoint:1.0:User'
required: true
meta:
description: Metadata of the ResourceType.
type: object
properties:
location:
description: The location of the ResourceType.
type: string
example: 'http://localhost:8080/iiq/scim/v2/ResourceTypes/User'
resourceType:
description: The SCIM resource type.
type: string
example: ResourceType
schemas:
description: The schema for the ResourceType resource.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:schemas:core:2.0:ResourceType'
application/scim+json:
schema:
properties:
totalResults:
description: Number of Schema resources returned.
type: integer
example: 18
schemas:
description: The Schema type represented by URN used for this response.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:api:messages:2.0:ListResponse'
Resources:
type: array
items:
type: object
properties:
id:
description: ID of the ResourceType.
type: string
example: User
name:
description: Name of the ResourceType.
type: string
example: User
endpoint:
description: The ResourceType's HTTP addressable endpoint relative to the Base URL.
type: string
example: /Applications
description:
description: Description of the ResourceType.
type: string
example: User Account.
schema:
description: The primary/base schema URI of the ResourceType.
type: string
example: 'urn:ietf:params:scim:schemas:sailpoint:1.0:User'
schemaExtensions:
description: A list of URIs of the ResourceType's schema extensions.
type: array
items:
example:
- schema: 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User'
required: true
- schema: 'urn:ietf:params:scim:schemas:sailpoint:1.0:User'
required: true
meta:
description: Metadata of the ResourceType.
type: object
properties:
location:
description: The location of the ResourceType.
type: string
example: 'http://localhost:8080/iiq/scim/v2/ResourceTypes/User'
resourceType:
description: The SCIM resource type.
type: string
example: ResourceType
schemas:
description: The schema for the ResourceType resource.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:schemas:core:2.0:ResourceType'
'/scim/v2/ResourceTypes/{resourceTypeId}':
get:
operationId: getResourceTypeById
tags:
- ResourceTypes
summary: Returns a ResourceType resource based on ID.
description: 'The ResourceType with the matching ID is returned. The ID is the URN of the SCIM resource. The common fields for each ResourceType entry are ''endpoint'', ''id'', ''name'', ''description'', ''schema'' and ''schemaExtensions''.'
parameters:
- name: resourceTypeId
in: path
schema:
type: string
description: ID of ResourceType resource.
required: true
responses:
'200':
description: Returns a single ResourceType resource based on the ID.
content:
application/json:
schema:
type: object
properties:
id:
description: ID of the ResourceType.
type: string
example: User
name:
description: Name of the ResourceType.
type: string
example: User
endpoint:
description: The ResourceType's HTTP addressable endpoint relative to the Base URL.
type: string
example: /Applications
description:
description: Description of the ResourceType.
type: string
example: User Account.
schema:
description: The primary/base schema URI of the ResourceType.
type: string
example: 'urn:ietf:params:scim:schemas:sailpoint:1.0:User'
schemaExtensions:
description: A list of URIs of the ResourceType's schema extensions.
type: array
items:
example:
- schema: 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User'
required: true
- schema: 'urn:ietf:params:scim:schemas:sailpoint:1.0:User'
required: true
meta:
description: Metadata of the ResourceType.
type: object
properties:
location:
description: The location of the ResourceType.
type: string
example: 'http://localhost:8080/iiq/scim/v2/ResourceTypes/User'
resourceType:
description: The SCIM resource type.
type: string
example: ResourceType
schemas:
description: The schema for the ResourceType resource.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:schemas:core:2.0:ResourceType'
/scim/v2/Roles:
get:
operationId: getRoles
tags:
- Roles
summary: Returns all Role resources.
description: 'This endpoint returns all Role resources. Attributes to include in the response can be specified with the ''attributes'' query parameter. Attributes to exclude from the response can be specified with the ''excludedAttributes'' query parameter. The core schema is urn:ietf:params:scim:schemas:sailpoint:1.0:Role.'
parameters:
- in: query
name: filter
schema:
type: string
description: 'Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported.
**Example**: filter=name eq "Data Analyst"'
- in: query
name: sortBy
schema:
type: string
description: 'Allows sorting the results by a resource''s attributes.
**Example**: sortBy="name"'
- in: query
name: sortOrder
schema:
type: string
description: 'Determines what order to sort results in.
**Example**: sortOrder="descending"'
- in: query
name: startIndex
schema:
type: integer
description: 'Determines the starting index of the result set.
**Example**: startIndex=1100'
- in: query
name: count
schema:
type: integer
description: 'Specifies the number of results per page.
**Example**: count=10'
- in: query
name: attributes
schema:
type: string
description: 'The Role attributes to include in the response. The query parameter value is a comma-separated list of fields to be returned in the response for each Role.
**Example**: attributes=name,type,classifications
The attributes listed will be the only ones returned in the response, with the exception of id, schemas, and meta, which are always returned for a Role.'
- in: query
name: excludedAttributes
schema:
type: string
description: 'The Role attributes to exclude frome the response. The query parameter value is a comma-separated list of fields to be excluded from the response for each Role.
**Example**: excludedAttributes=permits,requirements,inheritance
The attributes listed will be the only ones excluded frome the response, with the exception of id, schemas, and meta, which are always returned for a Role.'
responses:
'200':
description: Returns all SCIM Role resources.
content:
application/json:
schema:
properties:
totalResults:
description: Number of Role resources returned
type: integer
example: '18,'
startIndex:
description: The starting index of the resource set list. Can be specified with startIndex query parameter.
type: integer
example: 1
schemas:
description: SCIM Schema used for response.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:api:messages:2.0:ListResponse'
Resources:
type: array
items:
properties:
id:
description: IIQ ID of the Role.
type: string
example: c0b4568a4fe7458c434ee77d1fbt156b
name:
description: Unique name for the Role. This name MUST be unique across the entire set of Roles.
type: string
example: ADDirect-Production Manager
descriptions:
description: A list of localized descriptions of the Role.
type: array
example:
- locale: en_US
value: 'Directs production operations and processes for a plant, division, or company. Plans and maintains production schedules. Manages facilities and equipment maintenance.'
type:
description: The type of the Role.
type: object
example:
iiq: false
requirements: false
permits: false
displayName: IT
manualAssignment: false
name: it
autoAssignment: false
assignmentSelector: false
displayableName:
description: Displayable name of the Role.
type: string
example: Staging Test Engineer - IT
active:
description: Flag to indicate this Role is enabled or active.
type: boolean
example: true
activationDate:
description: The date the Role will turn from inactive/disabled to active/enabled.
type: string
format: date-time
example: '2022-02-11T01:08:45.866-05:00'
deactivationDate:
description: The date the Role will turn from active/enabled to inactive/disabled.
type: string
format: date-time
example: '2022-02-11T01:08:45.866-05:00'
owner:
description: The owner of the Role.
type: object
properties:
displayName:
description: Display name of the Role owner.
type: string
example: Lori Ferguson
value:
description: ID of the Role owner.
type: string
example: ac1301737f901991817f90d9eb050372
$ref:
description: URI reference of the Role owner resource.
type: string
example: 'http://localhost:8080/identityiq/scim/v2/Users/ac1301737f901991817f90d9eb050372'
inheritance:
description: Parent Roles this role inherits from.
type: array
properties:
displayName:
description: Display name of the parent Role.
type: string
example: Finance & Accounting
value:
description: ID of the parent Role.
type: string
example: ac1301737f901991817f90d9f054041c
$ref:
description: URI reference of the parent Role resource.
type: string
example: 'http://localhost:8080/identityiq/scim/v2/Roles/ac1301737f901991817f90d9f054041c'
requirements:
description: Roles this role requires. This is normally used with business roles to reference IT roles as a way of indicating which IT roles are required to support a business role.
type: array
properties:
displayName:
description: Display name of the required Role.
type: string
example: Accounting General Access - IT
value:
description: ID of the required Role.
type: string
example: ac1301737f901991817f90d9ed110387
$ref:
description: URI reference of the required Role resource.
type: string
example: 'http://localhost:8080/identityiq/scim/v2/Roles/ac1301737f901991817f90d9ed110387'
permits:
description: Roles this role permits. This is normally used with business roles to reference IT roles as a way of indicating which IT roles are allowed to support a business role.
type: array
properties:
displayName:
description: Display name of the permitted Role.
type: string
example: Accounts Payable Access - IT
value:
description: ID of the permitted Role.
type: string
example: ac1301737f901991817f90d9ed170388
$ref:
description: URI reference of the permitted Role resource.
type: string
example: 'http://localhost:8080/identityiq/scim/v2/Roles/ac1301737f901991817f90d9ed170388'
classifications:
description: Classifications of this Role.
type: array
example:
- effective: false
source: UI
classification:
displayName: Special2
origin: JDBCDirectDemoData
name: Special2
- effective: false
source: UI
classification:
displayName: Special7
origin: JDBCDirectDemoData
name: Special7
properties:
source:
description: The source of the ObjectClassification.
type: string
effective:
description: Flag indicating this is an effective Classification.
type: boolean
classification:
description: Classification of this Object.
type: object
properties:
name:
description: The name of the Classification.
type: string
displayName:
description: The displayName of the Classification.
type: string
origin:
description: The origin of the Classification.
type: string
type:
description: The type of the Classification. This can be used to group Classifications in/across different origins.
type: string
meta:
description: Metadata of the SCIM resource.
properties:
created:
description: Datetime this Role was created.
type: string
format: date-time
example: '2022-02-11T01:34:04.074-05:00'
location:
description: The location of the SCIM resource.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Roles/c0b4568a4fe7458c434ee77d1fbt156b'
lastModified:
description: Datetime the Role was last modified.
type: string
format: date-time
example: '2022-02-11T01:08:45.866-05:00'
version:
description: The version of the SCIM resource.
type: string
example: W/\"1644561244074\"
resourceType:
description: The SCIM resource type.
type: string
example: Role
schemas:
description: The schemas involved in the SCIM resource.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:schemas:sailpoint:1.0:Role'
application/scim+json:
schema:
properties:
totalResults:
description: Number of Role resources returned.
type: integer
example: '1500,'
startIndex:
description: The starting index of the resource set list. Can be specified with startIndex query parameter.
type: integer
example: 1
schemas:
description: SCIM Schema used for response.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:api:messages:2.0:ListResponse'
Resources:
description: The SCIM resources returned for this endpoint.
type: array
items:
properties:
id:
description: IIQ ID of the Role.
type: string
example: c0b4568a4fe7458c434ee77d1fbt156b
name:
description: Unique name for the Role. This name MUST be unique across the entire set of Roles.
type: string
example: ADDirect-Production Manager
descriptions:
description: A list of localized descriptions of the Role.
type: array
example:
- locale: en_US
value: 'Directs production operations and processes for a plant, division, or company. Plans and maintains production schedules. Manages facilities and equipment maintenance.'
type:
description: The type of the Role.
type: object
example:
iiq: false
requirements: false
permits: false
displayName: IT
manualAssignment: false
name: it
autoAssignment: false
assignmentSelector: false
displayableName:
description: Displayable name of the Role.
type: string
example: Staging Test Engineer - IT
active:
description: Flag to indicate this Role is enabled or active.
type: boolean
example: true
activationDate:
description: The date the Role will turn from inactive/disabled to active/enabled.
type: string
format: date-time
example: '2022-02-11T01:08:45.866-05:00'
deactivationDate:
description: The date the Role will turn from active/enabled to inactive/disabled.
type: string
format: date-time
example: '2022-02-11T01:08:45.866-05:00'
owner:
description: The owner of the Role.
type: object
properties:
displayName:
description: Display name of the Role owner.
type: string
example: Lori Ferguson
value:
description: ID of the Role owner.
type: string
example: ac1301737f901991817f90d9eb050372
$ref:
description: URI reference of the Role owner resource.
type: string
example: 'http://localhost:8080/identityiq/scim/v2/Users/ac1301737f901991817f90d9eb050372'
inheritance:
description: Parent Roles this role inherits from.
type: array
properties:
displayName:
description: Display name of the parent Role.
type: string
example: Finance & Accounting
value:
description: ID of the parent Role.
type: string
example: ac1301737f901991817f90d9f054041c
$ref:
description: URI reference of the parent Role resource.
type: string
example: 'http://localhost:8080/identityiq/scim/v2/Roles/ac1301737f901991817f90d9f054041c'
requirements:
description: Roles this role requires. This is normally used with business roles to reference IT roles as a way of indicating which IT roles are required to support a business role.
type: array
properties:
displayName:
description: Display name of the required Role.
type: string
example: Accounting General Access - IT
value:
description: ID of the required Role.
type: string
example: ac1301737f901991817f90d9ed110387
$ref:
description: URI reference of the required Role resource.
type: string
example: 'http://localhost:8080/identityiq/scim/v2/Roles/ac1301737f901991817f90d9ed110387'
permits:
description: Roles this role permits. This is normally used with business roles to reference IT roles as a way of indicating which IT roles are allowed to support a business role.
type: array
properties:
displayName:
description: Display name of the permitted Role.
type: string
example: Accounts Payable Access - IT
value:
description: ID of the permitted Role.
type: string
example: ac1301737f901991817f90d9ed170388
$ref:
description: URI reference of the permitted Role resource.
type: string
example: 'http://localhost:8080/identityiq/scim/v2/Roles/ac1301737f901991817f90d9ed170388'
classifications:
description: Classifications of this Role.
type: array
example:
- effective: false
source: UI
classification:
displayName: Special2
origin: JDBCDirectDemoData
name: Special2
- effective: false
source: UI
classification:
displayName: Special7
origin: JDBCDirectDemoData
name: Special7
properties:
source:
description: The source of the ObjectClassification.
type: string
effective:
description: Flag indicating this is an effective Classification.
type: boolean
classification:
description: Classification of this Object.
type: object
properties:
name:
description: The name of the Classification.
type: string
displayName:
description: The displayName of the Classification.
type: string
origin:
description: The origin of the Classification.
type: string
type:
description: The type of the Classification. This can be used to group Classifications in/across different origins.
type: string
meta:
description: Metadata of the SCIM resource.
properties:
created:
description: Datetime this Role was created.
type: string
format: date-time
example: '2022-02-11T01:34:04.074-05:00'
location:
description: The location of the SCIM resource.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Roles/c0b4568a4fe7458c434ee77d1fbt156b'
lastModified:
description: Datetime the Role was last modified.
type: string
format: date-time
example: '2022-02-11T01:08:45.866-05:00'
version:
description: The version of the SCIM resource.
type: string
example: W/\"1644561244074\"
resourceType:
description: The SCIM resource type.
type: string
example: Role
schemas:
description: The schemas involved in the SCIM resource.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:schemas:sailpoint:1.0:Role'
'/scim/v2/Roles/{roleId}':
get:
operationId: getRole
tags:
- Roles
summary: Returns a Role resource based on ID or name.
description: 'The Role resource with matching ID or name is returned. Attributes to include in the response can be specified with the ''attributes'' query parameter. Attributes to exclude from the response can be specified with the ''excludedAttributes'' query parameter. The core schema is urn:ietf:params:scim:schemas:sailpoint:1.0:Role.'
parameters:
- name: roleId
in: path
schema:
type: string
description: ID or name of Role resource.
required: true
- in: query
name: lookupByName
schema:
type: boolean
description: 'A boolean value that determines if the Role resource will be looked up by name instead of Id (value in path parameter ''roleId''). Setting this query parameter to true will cause the value pulled from the ''roleId'' path parameter to be treated as a name when searching for the resource.
**Example**: scim/v2/Roles/**Data Analyst**?**lookupByName=true**'
- in: query
name: attributes
schema:
type: string
description: 'The Role attributes to include in the response. The query parameter value is a comma-separated list of fields to be returned in the response for each Role.
**Example**: attributes=name,type
The attributes listed will be the only ones returned in the response, with the exception of id, schemas, and meta, which are always returned for a Role.'
- in: query
name: excludedAttributes
schema:
type: string
description: 'The Role attributes to exclude frome the response. The query parameter value is a comma-separated list of fields to be excluded from the response for each Role.
**Example**: excludedAttributes=permits,requirements
The attributes listed will be the only ones excluded frome the response, with the exception of id, schemas, and meta, which are always returned for a Role.'
responses:
'200':
description: Returns a single Role resource based on the ID.
content:
application/json:
schema:
properties:
id:
description: IIQ ID of the Role.
type: string
example: c0b4568a4fe7458c434ee77d1fbt156b
name:
description: Unique name for the Role. This name MUST be unique across the entire set of Roles.
type: string
example: ADDirect-Production Manager
descriptions:
description: A list of localized descriptions of the Role.
type: array
example:
- locale: en_US
value: 'Directs production operations and processes for a plant, division, or company. Plans and maintains production schedules. Manages facilities and equipment maintenance.'
type:
description: The type of the Role.
type: object
example:
iiq: false
requirements: false
permits: false
displayName: IT
manualAssignment: false
name: it
autoAssignment: false
assignmentSelector: false
displayableName:
description: Displayable name of the Role.
type: string
example: Staging Test Engineer - IT
active:
description: Flag to indicate this Role is enabled or active.
type: boolean
example: true
activationDate:
description: The date the Role will turn from inactive/disabled to active/enabled.
type: string
format: date-time
example: '2022-02-11T01:08:45.866-05:00'
deactivationDate:
description: The date the Role will turn from active/enabled to inactive/disabled.
type: string
format: date-time
example: '2022-02-11T01:08:45.866-05:00'
owner:
description: The owner of the Role.
type: object
properties:
displayName:
description: Display name of the Role owner.
type: string
example: Lori Ferguson
value:
description: ID of the Role owner.
type: string
example: ac1301737f901991817f90d9eb050372
$ref:
description: URI reference of the Role owner resource.
type: string
example: 'http://localhost:8080/identityiq/scim/v2/Users/ac1301737f901991817f90d9eb050372'
inheritance:
description: Parent Roles this role inherits from.
type: array
properties:
displayName:
description: Display name of the parent Role.
type: string
example: Finance & Accounting
value:
description: ID of the parent Role.
type: string
example: ac1301737f901991817f90d9f054041c
$ref:
description: URI reference of the parent Role resource.
type: string
example: 'http://localhost:8080/identityiq/scim/v2/Roles/ac1301737f901991817f90d9f054041c'
requirements:
description: Roles this role requires. This is normally used with business roles to reference IT roles as a way of indicating which IT roles are required to support a business role.
type: array
properties:
displayName:
description: Display name of the required Role.
type: string
example: Accounting General Access - IT
value:
description: ID of the required Role.
type: string
example: ac1301737f901991817f90d9ed110387
$ref:
description: URI reference of the required Role resource.
type: string
example: 'http://localhost:8080/identityiq/scim/v2/Roles/ac1301737f901991817f90d9ed110387'
permits:
description: Roles this role permits. This is normally used with business roles to reference IT roles as a way of indicating which IT roles are allowed to support a business role.
type: array
properties:
displayName:
description: Display name of the permitted Role.
type: string
example: Accounts Payable Access - IT
value:
description: ID of the permitted Role.
type: string
example: ac1301737f901991817f90d9ed170388
$ref:
description: URI reference of the permitted Role resource.
type: string
example: 'http://localhost:8080/identityiq/scim/v2/Roles/ac1301737f901991817f90d9ed170388'
classifications:
description: Classifications of this Role.
type: array
example:
- effective: false
source: UI
classification:
displayName: Special2
origin: JDBCDirectDemoData
name: Special2
- effective: false
source: UI
classification:
displayName: Special7
origin: JDBCDirectDemoData
name: Special7
properties:
source:
description: The source of the ObjectClassification.
type: string
effective:
description: Flag indicating this is an effective Classification.
type: boolean
classification:
description: Classification of this Object.
type: object
properties:
name:
description: The name of the Classification.
type: string
displayName:
description: The displayName of the Classification.
type: string
origin:
description: The origin of the Classification.
type: string
type:
description: The type of the Classification. This can be used to group Classifications in/across different origins.
type: string
meta:
description: Metadata of the SCIM resource.
properties:
created:
description: Datetime this Role was created.
type: string
format: date-time
example: '2022-02-11T01:34:04.074-05:00'
location:
description: The location of the SCIM resource.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Roles/c0b4568a4fe7458c434ee77d1fbt156b'
lastModified:
description: Datetime the Role was last modified.
type: string
format: date-time
example: '2022-02-11T01:08:45.866-05:00'
version:
description: The version of the SCIM resource.
type: string
example: W/\"1644561244074\"
resourceType:
description: The SCIM resource type.
type: string
example: Role
schemas:
description: The schemas involved in the SCIM resource.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:schemas:sailpoint:1.0:Role'
/scim/v2/Schemas:
get:
operationId: getSchemas
tags:
- Schemas
summary: Returns all Schema resources.
description: All Schema resources are listed in the response. The 'attributes' field holds the schema-specific attributes which differ depending on Schema type.
responses:
'200':
description: Returns all Schema resources.
content:
application/json:
schema:
properties:
totalResults:
description: Number of Schemas returned.
type: integer
example: 18
schemas:
description: The Schema type used for this response.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:api:messages:2.0:ListResponse'
Resources:
type: array
items:
type: object
properties:
id:
description: The id of the Schema. The id is the SCIM URN of the Schema.
type: string
example: 'urn:ietf:params:scim:schemas:sailpoint:1.0:User'
name:
description: Name of the Schema.
type: string
example: User
description:
description: Description of the Schema.
type: string
example: Schema for a SCIM User.
attributes:
description: Attributes used to describe this Schema.
type: array
items:
properties:
uniqueness:
description: 'Determines whether there can be other Schema resources with the same value for this attribute. ''none'' means there is no concern for uniqueness, ''server'' means the uniqueness of this attribute should be guaranteed for this type of resource, and ''global'' means the uniqueness should be guaranteed across all resources.'
type: string
example: none
name:
description: Name of the attribute.
type: string
example: displayName
description:
description: Description of the attribute.
type: string
example: Display name of the User.
mutability:
description: 'Indicates the ability to change this attribute. Possible values are ''readOnly'', ''readWrite'', and ''writeOnly''.'
type: string
example: readOnly
type:
description: 'Defined as ''simple'' or ''complex'', where simple indicates attribute values stored as strings, integers, etc., and complex indicates object-based values.'
type: string
example: string
multiValued:
description: Describes whether this attribute is allowed multiple values.
type: boolean
example: false
caseExact:
description: True if attribute value is case-sensitive; false otherwise.
type: boolean
example: false
returned:
description: 'Dictates whether the attribute should be returned in a SCIM response body. Can be ''always'', ''default'', ''request'', or ''never''.'
type: string
example: default
required:
description: True if this attribute is required for this Schema; false otherwise.
type: boolean
example: false
canonicalValues:
description: List of canonical values that could be used to supplement attribute.
type: array
items:
type: string
example:
- httpbasic
- httpdigest
- oauth
subAttributes:
description: 'Only required if ''complex'' is specified for ''type''. If this attribute is of ''complex'' type, an array of objects can be stored in ''subAttributes'' with attributes relevant to the respective Schema.'
type: array
items:
additionalProperties:
anyOf:
- type: object
meta:
description: Metadata of the Schema.
type: object
properties:
location:
description: The location of the Schema.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Schemas/7f0123417e941b00007f9db3702906cb'
version:
description: The version of the Schema.
type: string
example: W"1647617443639"
resourceType:
description: The SCIM resource type.
type: string
example: Schema
schemas:
description: The schema for the Schema resource.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:schemas:core:2.0:Schema'
application/scim+json:
schema:
properties:
totalResults:
description: Number of Schemas returned.
type: integer
example: 18
schemas:
description: The Schema type used for this response.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:api:messages:2.0:ListResponse'
Resources:
type: array
items:
type: object
properties:
id:
description: The id of the Schema. The id is the SCIM URN of the Schema.
type: string
example: 'urn:ietf:params:scim:schemas:sailpoint:1.0:User'
name:
description: Name of the Schema.
type: string
example: User
description:
description: Description of the Schema.
type: string
example: Schema for a SCIM User.
attributes:
description: Attributes used to describe this Schema.
type: array
items:
properties:
uniqueness:
description: 'Determines whether there can be other Schema resources with the same value for this attribute. ''none'' means there is no concern for uniqueness, ''server'' means the uniqueness of this attribute should be guaranteed for this type of resource, and ''global'' means the uniqueness should be guaranteed across all resources.'
type: string
example: none
name:
description: Name of the attribute.
type: string
example: displayName
description:
description: Description of the attribute.
type: string
example: Display name of the User.
mutability:
description: 'Indicates the ability to change this attribute. Possible values are ''readOnly'', ''readWrite'', and ''writeOnly''.'
type: string
example: readOnly
type:
description: 'Defined as ''simple'' or ''complex'', where simple indicates attribute values stored as strings, integers, etc., and complex indicates object-based values.'
type: string
example: string
multiValued:
description: Describes whether this attribute is allowed multiple values.
type: boolean
example: false
caseExact:
description: True if attribute value is case-sensitive; false otherwise.
type: boolean
example: false
returned:
description: 'Dictates whether the attribute should be returned in a SCIM response body. Can be ''always'', ''default'', ''request'', or ''never''.'
type: string
example: default
required:
description: True if this attribute is required for this Schema; false otherwise.
type: boolean
example: false
canonicalValues:
description: List of canonical values that could be used to supplement attribute.
type: array
items:
type: string
example:
- httpbasic
- httpdigest
- oauth
subAttributes:
description: 'Only required if ''complex'' is specified for ''type''. If this attribute is of ''complex'' type, an array of objects can be stored in ''subAttributes'' with attributes relevant to the respective Schema.'
type: array
items:
additionalProperties:
anyOf:
- type: object
meta:
description: Metadata of the Schema.
type: object
properties:
location:
description: The location of the Schema.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Schemas/7f0123417e941b00007f9db3702906cb'
version:
description: The version of the Schema.
type: string
example: W"1647617443639"
resourceType:
description: The SCIM resource type.
type: string
example: Schema
schemas:
description: The schema for the Schema resource.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:schemas:core:2.0:Schema'
'/scim/v2/Schemas/{schemaId}':
get:
operationId: getSchemaById
tags:
- Schemas
summary: Returns a Schema based on id.
description: The Schema with the matching id is returned. The id is the URN of the SCIM resource. The 'attributes' field holds the schema-specific attributes which differ depending on Schema type.
parameters:
- name: schemaId
in: path
schema:
type: string
description: The id of the Schema.
required: true
responses:
'200':
description: Returns a single Schema based on the id.
content:
application/json:
schema:
type: object
properties:
id:
description: The id of the Schema. The id is the SCIM URN of the Schema.
type: string
example: 'urn:ietf:params:scim:schemas:sailpoint:1.0:User'
name:
description: Name of the Schema.
type: string
example: User
description:
description: Description of the Schema.
type: string
example: Schema for a SCIM User.
attributes:
description: Attributes used to describe this Schema.
type: array
items:
properties:
uniqueness:
description: 'Determines whether there can be other Schema resources with the same value for this attribute. ''none'' means there is no concern for uniqueness, ''server'' means the uniqueness of this attribute should be guaranteed for this type of resource, and ''global'' means the uniqueness should be guaranteed across all resources.'
type: string
example: none
name:
description: Name of the attribute.
type: string
example: displayName
description:
description: Description of the attribute.
type: string
example: Display name of the User.
mutability:
description: 'Indicates the ability to change this attribute. Possible values are ''readOnly'', ''readWrite'', and ''writeOnly''.'
type: string
example: readOnly
type:
description: 'Defined as ''simple'' or ''complex'', where simple indicates attribute values stored as strings, integers, etc., and complex indicates object-based values.'
type: string
example: string
multiValued:
description: Describes whether this attribute is allowed multiple values.
type: boolean
example: false
caseExact:
description: True if attribute value is case-sensitive; false otherwise.
type: boolean
example: false
returned:
description: 'Dictates whether the attribute should be returned in a SCIM response body. Can be ''always'', ''default'', ''request'', or ''never''.'
type: string
example: default
required:
description: True if this attribute is required for this Schema; false otherwise.
type: boolean
example: false
canonicalValues:
description: List of canonical values that could be used to supplement attribute.
type: array
items:
type: string
example:
- httpbasic
- httpdigest
- oauth
subAttributes:
description: 'Only required if ''complex'' is specified for ''type''. If this attribute is of ''complex'' type, an array of objects can be stored in ''subAttributes'' with attributes relevant to the respective Schema.'
type: array
items:
additionalProperties:
anyOf:
- type: object
meta:
description: Metadata of the Schema.
type: object
properties:
location:
description: The location of the Schema.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Schemas/7f0123417e941b00007f9db3702906cb'
version:
description: The version of the Schema.
type: string
example: W"1647617443639"
resourceType:
description: The SCIM resource type.
type: string
example: Schema
schemas:
description: The schema for the Schema resource.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:schemas:core:2.0:Schema'
/scim/v2/ServiceProviderConfig:
description: Schema for representing the service provider's configuration
get:
operationId: ServiceProviderConfigGet
tags:
- ServiceProviderConfig
summary: Returns all ServiceProviderConfig resources.
description: |
This endpoint returns all ServiceProviderConfig resources.
Attributes to include in the response can be specified with the 'attributes' query parameter.
Attributes to exclude from the response can be specified with the 'excludedAttributes' query parameter.
The schema related to ServiceProviderConfig is:
- **urn:ietf:params:scim:schemas:sailpoint:2.0:ServiceProviderConfig**
responses:
'200':
description: Returned all SCIM resources for this endpoint.
content:
application/json:
schema:
properties:
totalResults:
description: Number of resources returned for this endpoint.
type: integer
example: '1,'
startIndex:
description: The starting index of the resource set list. Can be specified with startIndex query parameter.
type: integer
example: 1
schemas:
description: SCIM Schema used for response.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:api:messages:2.0:ListResponse'
Resources:
type: array
items:
required:
- patch
- etag
- bulk
- filter
- changePassword
- sort
- authenticationSchemes
properties:
documentationUri:
description: An HTTP addressable URL pointing to the service provider's human consumable help documentation.
type: string
example: 'https://community.sailpoint.com/community/identityiq/product-downloads'
patch:
description: A complex type that specifies PATCH configuration options.
type: object
required:
- supported
properties:
supported:
type: boolean
description: Boolean value specifying whether the operation is supported.
example: false
etag:
description: A complex type that specifies ETAG configuration options.
type: object
required:
- supported
properties:
supported:
description: Boolean value specifying whether the operation is supported.
type: boolean
bulk:
description: A complex type that specifies ETAG configuration options.
type: object
required:
- supported
- maxOperations
- maxPayloadSize
properties:
supported:
description: Boolean value specifying whether the operation is supported.
type: boolean
example: false
maxOperations:
description: An integer value specifying the maximum number of operations.
type: integer
example: 3
maxPayloadSize:
description: An integer value specifying the maximum payload size in bytes.
type: integer
example: 128
filter:
description: A complex type that specifies FILTER options.
type: object
required:
- supported
- maxResults
properties:
supported:
description: Boolean value specifying whether the operation is supported.
type: boolean
example: true
maxResults:
description: Integer value specifying the maximum number of resources returned in a response.
type: integer
example: 10
changePassword:
description: A complex type that specifies change password options.
type: object
required:
- supported
properties:
supported:
description: Boolean value specifying whether the operation is supported.
type: boolean
example: false
sort:
description: A complex type that specifies sort result options.
type: object
required:
- supported
properties:
supported:
description: Boolean value specifying whether the operation is supported.
type: boolean
example: false
authenticationSchemes:
description: A complex type that specifies supported Authentication Scheme properties.
type: object
required:
- name
- description
- type
properties:
name:
description: 'The common authentication scheme name; e.g., HTTP Basic.'
type: string
example: HTTP Basic
description:
description: A description of the authentication scheme.
type: string
example: Authentication Scheme using the Http Basic Standard.
specUri:
description: An HTTP addressable URL pointing to the Authentication Scheme's specification.
type: string
example: 'http://www.ietf.org/rfc/rfc2617.txt'
documentationUri:
description: An HTTP addressable URL pointing to the Authentication Scheme's usage documentation.
type: string
example: 'https://community.sailpoint.com/community/identityiq/product-downloads'
type:
type: string
description: The authentication scheme.
enum:
- oauth
- oauth2
- oauthbearertoken
- httpbasic
- httpdigest
example: oauthbearertoken
meta:
type: object
properties:
location:
type: string
description: URL to ServiceProviderConfig resource.
example: 'http://localhost:8080/identityiq/scim/v2/ServiceProviderConfig'
resourceType:
type: string
description: Resource type of the metadata subject.
example: ServiceProviderConfig
application/scim+json:
schema:
properties:
maxResults:
description: Number of ServiceProviderConfig resources returned.
type: integer
example: '1500,'
supported:
type: boolean
example: true
schemas:
description: SCIM Schema used for response.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:api:messages:2.0:ListResponse'
Resources:
description: The SCIM resources returned for this endpoint.
type: array
items:
required:
- patch
- etag
- bulk
- filter
- changePassword
- sort
- authenticationSchemes
properties:
documentationUri:
description: An HTTP addressable URL pointing to the service provider's human consumable help documentation.
type: string
example: 'https://community.sailpoint.com/community/identityiq/product-downloads'
patch:
description: A complex type that specifies PATCH configuration options.
type: object
required:
- supported
properties:
supported:
type: boolean
description: Boolean value specifying whether the operation is supported.
example: false
etag:
description: A complex type that specifies ETAG configuration options.
type: object
required:
- supported
properties:
supported:
description: Boolean value specifying whether the operation is supported.
type: boolean
bulk:
description: A complex type that specifies ETAG configuration options.
type: object
required:
- supported
- maxOperations
- maxPayloadSize
properties:
supported:
description: Boolean value specifying whether the operation is supported.
type: boolean
example: false
maxOperations:
description: An integer value specifying the maximum number of operations.
type: integer
example: 3
maxPayloadSize:
description: An integer value specifying the maximum payload size in bytes.
type: integer
example: 128
filter:
description: A complex type that specifies FILTER options.
type: object
required:
- supported
- maxResults
properties:
supported:
description: Boolean value specifying whether the operation is supported.
type: boolean
example: true
maxResults:
description: Integer value specifying the maximum number of resources returned in a response.
type: integer
example: 10
changePassword:
description: A complex type that specifies change password options.
type: object
required:
- supported
properties:
supported:
description: Boolean value specifying whether the operation is supported.
type: boolean
example: false
sort:
description: A complex type that specifies sort result options.
type: object
required:
- supported
properties:
supported:
description: Boolean value specifying whether the operation is supported.
type: boolean
example: false
authenticationSchemes:
description: A complex type that specifies supported Authentication Scheme properties.
type: object
required:
- name
- description
- type
properties:
name:
description: 'The common authentication scheme name; e.g., HTTP Basic.'
type: string
example: HTTP Basic
description:
description: A description of the authentication scheme.
type: string
example: Authentication Scheme using the Http Basic Standard.
specUri:
description: An HTTP addressable URL pointing to the Authentication Scheme's specification.
type: string
example: 'http://www.ietf.org/rfc/rfc2617.txt'
documentationUri:
description: An HTTP addressable URL pointing to the Authentication Scheme's usage documentation.
type: string
example: 'https://community.sailpoint.com/community/identityiq/product-downloads'
type:
type: string
description: The authentication scheme.
enum:
- oauth
- oauth2
- oauthbearertoken
- httpbasic
- httpdigest
example: oauthbearertoken
meta:
type: object
properties:
location:
type: string
description: URL to ServiceProviderConfig resource.
example: 'http://localhost:8080/identityiq/scim/v2/ServiceProviderConfig'
resourceType:
type: string
description: Resource type of the metadata subject.
example: ServiceProviderConfig
/scim/v2/TaskResults:
get:
operationId: TaskResultsGet
tags:
- Task Results
summary: Returns all TaskResult resources.
description: |
This endpoint returns all TaskResult resources.
Attributes to include in the response can be specified with the 'attributes' query parameter.
Attributes to exclude from the response can be specified with the 'excludedAttributes' query parameter.
The schema related to TaskResult is:
- **urn:ietf:params:scim:schemas:sailpoint:1.0:TaskResult**
parameters:
- in: query
name: filter
schema:
type: string
example: name eq "AdminsAggTask"
description: 'Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported.'
- in: query
name: lookupByName
schema:
type: boolean
default: false
example: true
description: '**(OPTIONAL)** Set to true if the TaskResult name is passed instead of the TaskResult id.'
- in: query
name: sortBy
schema:
type: string
example: launched
description: Allows sorting the results by a resource's attributes.
- in: query
name: sortOrder
schema:
type: string
default: ascending
example: descending
description: Determines what order to sort results in.
- in: query
name: startIndex
schema:
type: integer
example: 10
default: 1
description: Determines the starting index of the result set.
- in: query
name: count
schema:
type: integer
example: 5
default: 1000
description: Specifies the number of results per page.
- in: query
name: attributes
schema:
type: string
example: 'completionStatus, attributes'
description: 'A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.'
- in: query
name: excludedAttributes
schema:
type: string
example: 'taskDefinition, host'
description: A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**
responses:
'200':
description: Returned all SCIM resources for this endpoint.
content:
application/json:
schema:
properties:
totalResults:
description: Number of resources returned for this endpoint
type: integer
example: '1,'
startIndex:
description: The starting index of the resource set list. Can be specified with startIndex query parameter.
type: integer
example: 1
schemas:
description: SCIM Schema used for response.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:api:messages:2.0:ListResponse'
Resources:
type: array
items:
properties:
id:
description: Unique identifier of the TaskResult.
type: string
example: 7f00000180281df7818028c03252085c
name:
description: Name of the TaskResult.
type: string
example: Aggregate HR Authoritative
type:
description: Type of the TaskResult.
type: string
example: AccountAggregation
completionStatus:
type: string
description: Completion Status of the TaskResult.
enum:
- Success
- Warning
- Error
- Terminated
- TempError
example: Success
launcher:
description: Launcher of the TaskResult.
type: string
example: spadmin
host:
description: Host of the TaskResult.
type: string
example: centos-server.local
progress:
description: Progress of the TaskResult.
type: string
example: Launched 2 partitions.
targetClass:
description: Target Class of the TaskResult.
type: string
example: Permission
targetName:
description: Target Name of the Task Result.
type: string
example: PAM Credential Container
terminated:
description: Flag to indicate this TaskResult is terminated.
type: boolean
example: true
partitioned:
description: Flag to indicate this TaskResult is partitioned.
type: boolean
example: true
launched:
type: string
format: date-time
description: The launched DateTime of the TaskResult.
example: '2022-04-14T10:45:26.114-05:00'
completed:
type: string
format: date-time
description: The completed DateTime of the TaskResult.
example: '2022-04-14T10:45:26.098-05:00'
expiration:
type: string
format: date-time
description: The expiration DateTime of the TaskResult.
example: '2022-05-03T16:40:34.271-05:00'
verified:
type: string
format: date-time
description: The verification DateTime of the TaskResult.
example: '2022-05-03T16:40:34.271-05:00'
percentageComplete:
type: integer
description: The percentage completed of this TaskResult.
example: 55
pendingSignOffs:
description: The number of pending signoffs of this TaskResult.
type: integer
example: 2
taskDefinition:
type: string
description: Name of the TaskDefinition of the TaskResult.
example: Aggregate HR Authoritative
taskSchedule:
description: Name of the TaskSchedule of the TaskResult.
type: string
example: Perform maintenance
attributes:
description: A list of attributes of the TaskResult.
type: array
items:
properties:
key:
description: The attribute key.
type: string
example: total
value:
description: The attribute value.
type: string
example: '3'
messages:
description: List of messages of the TaskResult.
type: array
items:
example:
- 'Unathorized access to database in server: 192.100.1.25'
meta:
type: object
properties:
created:
description: DateTime when the TaskResult was created.
type: string
format: date-time
example: '2022-04-14T10:44:54.834-05:00'
location:
description: URL to the TaskResult.
type: string
example: 'http://localhost:8080/identityiq/scim/v2/TaskResults/7f00000180281df7818028c03252085c'
lastModified:
description: DateTime of TaskResult last modification.
type: string
format: date-time
example: '2022-04-05T15:52:30.119-05:00'
version:
description: TaskResult version.
type: string
example: '"W"1649951094834"'
resourceType:
description: Resource type of the metadata subject.
type: string
example: TaskResult
schemas:
type: array
example:
- 'urn:ietf:params:scim:schemas:sailpoint:1.0:TaskResult'
application/scim+json:
schema:
properties:
totalResults:
description: Number of TaskResult resources returned.
type: integer
example: '1500,'
startIndex:
description: The starting index of the resource set list. Can be specified with startIndex query parameter.
type: integer
example: 1
schemas:
description: SCIM Schema used for response.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:api:messages:2.0:ListResponse'
Resources:
description: The SCIM resources returned for this endpoint.
type: array
items:
properties:
id:
description: Unique identifier of the TaskResult.
type: string
example: 7f00000180281df7818028c03252085c
name:
description: Name of the TaskResult.
type: string
example: Aggregate HR Authoritative
type:
description: Type of the TaskResult.
type: string
example: AccountAggregation
completionStatus:
type: string
description: Completion Status of the TaskResult.
enum:
- Success
- Warning
- Error
- Terminated
- TempError
example: Success
launcher:
description: Launcher of the TaskResult.
type: string
example: spadmin
host:
description: Host of the TaskResult.
type: string
example: centos-server.local
progress:
description: Progress of the TaskResult.
type: string
example: Launched 2 partitions.
targetClass:
description: Target Class of the TaskResult.
type: string
example: Permission
targetName:
description: Target Name of the Task Result.
type: string
example: PAM Credential Container
terminated:
description: Flag to indicate this TaskResult is terminated.
type: boolean
example: true
partitioned:
description: Flag to indicate this TaskResult is partitioned.
type: boolean
example: true
launched:
type: string
format: date-time
description: The launched DateTime of the TaskResult.
example: '2022-04-14T10:45:26.114-05:00'
completed:
type: string
format: date-time
description: The completed DateTime of the TaskResult.
example: '2022-04-14T10:45:26.098-05:00'
expiration:
type: string
format: date-time
description: The expiration DateTime of the TaskResult.
example: '2022-05-03T16:40:34.271-05:00'
verified:
type: string
format: date-time
description: The verification DateTime of the TaskResult.
example: '2022-05-03T16:40:34.271-05:00'
percentageComplete:
type: integer
description: The percentage completed of this TaskResult.
example: 55
pendingSignOffs:
description: The number of pending signoffs of this TaskResult.
type: integer
example: 2
taskDefinition:
type: string
description: Name of the TaskDefinition of the TaskResult.
example: Aggregate HR Authoritative
taskSchedule:
description: Name of the TaskSchedule of the TaskResult.
type: string
example: Perform maintenance
attributes:
description: A list of attributes of the TaskResult.
type: array
items:
properties:
key:
description: The attribute key.
type: string
example: total
value:
description: The attribute value.
type: string
example: '3'
messages:
description: List of messages of the TaskResult.
type: array
items:
example:
- 'Unathorized access to database in server: 192.100.1.25'
meta:
type: object
properties:
created:
description: DateTime when the TaskResult was created.
type: string
format: date-time
example: '2022-04-14T10:44:54.834-05:00'
location:
description: URL to the TaskResult.
type: string
example: 'http://localhost:8080/identityiq/scim/v2/TaskResults/7f00000180281df7818028c03252085c'
lastModified:
description: DateTime of TaskResult last modification.
type: string
format: date-time
example: '2022-04-05T15:52:30.119-05:00'
version:
description: TaskResult version.
type: string
example: '"W"1649951094834"'
resourceType:
description: Resource type of the metadata subject.
type: string
example: TaskResult
schemas:
type: array
example:
- 'urn:ietf:params:scim:schemas:sailpoint:1.0:TaskResult'
'/scim/v2/TaskResults/{taskResultId}':
get:
operationId: getTaskResultById
tags:
- Task Results
summary: Returns a TaskResult resource based on id.
description: |
The TaskResult resource with matching id is returned.
Attributes to include in the response can be specified with the attributes query parameter.
Attributes to exclude from the response can be specified with the excludedAttributes query parameter.
The schema related to TaskResult is:
- **urn:ietf:params:scim:schemas:sailpoint:1.0:TaskResult**
parameters:
- name: taskResultId
in: path
schema:
type: string
example: c0a8019c802d1e5a81802eb2b57e020f
description: id of TaskResult resource.
required: true
- in: query
name: attributes
schema:
type: string
example: host
description: 'A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.'
- in: query
name: excludedAttributes
schema:
type: string
example: 'name, messages'
description: A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**
responses:
'200':
description: Returns a single TaskResult resource based on the id.
content:
application/json:
schema:
properties:
id:
description: Unique identifier of the TaskResult.
type: string
example: c0a8019c80761c398180856488d2051d
name:
description: Name of the TaskResult.
type: string
example: Aggregate Composite Application
type:
description: Type of the TaskResult.
type: string
example: AccountAggregation
completionStatus:
type: string
description: Completion Status of the TaskResult.
enum:
- Success
- Warning
- Error
- Terminated
- TempError
example: Success
launcher:
description: Launcher of the TaskResult.
type: string
example: james.smith
host:
description: Host of the TaskResult.
type: string
example: mandrake.testdomain.com
progress:
description: Progress of the TaskResult.
type: string
example: 3/5 tasks completed.
targetClass:
description: Target Class of the TaskResult.
type: string
example: Permission
targetName:
description: Target Name of the Task Result.
type: string
example: Adam.Kennedy
terminated:
description: Flag to indicate this TaskResult is terminated.
type: boolean
example: false
partitioned:
description: Flag to indicate this TaskResult is partitioned.
type: boolean
example: true
launched:
type: string
format: date-time
description: The launched DateTime of the TaskResult.
example: '2022-05-02T10:30:00.014-05:00'
completed:
type: string
format: date-time
description: The completed DateTime of the TaskResult.
example: '2022-05-02T10:30:00.035-05:00'
expiration:
type: string
format: date-time
description: The expiration DateTime of the TaskResult.
example: '2022-05-03T16:40:34.271-05:00'
verified:
type: string
format: date-time
description: The verification DateTime of the TaskResult.
example: '2022-05-03T16:40:34.271-05:00'
percentageComplete:
type: integer
description: The percentage completed of this TaskResult.
example: 30
pendingSignOffs:
description: The number of pending signoffs of this TaskResult.
type: integer
example: 0
taskDefinition:
type: string
description: Name of the TaskDefinition of the TaskResult.
example: Workflow Launcher
taskSchedule:
description: Name of the TaskSchedule of the TaskResult.
type: string
example: Perform Identity Request Maintenance
attributes:
description: A list of attributes of the TaskResult.
type: array
items:
properties:
key:
description: The attribute key.
type: string
example: inactiveWorkItemsForwarded
value:
description: The attribute value.
type: string
example: '0'
messages:
description: List of messages of the TaskResult.
type: array
items:
example:
- Partition 2 is pending.
meta:
type: object
properties:
created:
description: DateTime when the TaskResult was created.
type: string
format: date-time
example: '2022-05-02T10:30:00.018-05:00'
location:
description: URL to the TaskResult.
type: string
example: 'http://localhost:8080/identityiq/scim/v2/TaskResults/c0a8019c80761c398180856488d2051d'
lastModified:
description: DateTime of TaskResult last modification.
type: string
format: date-time
example: '2022-05-02T10:30:00.036-05:00'
version:
description: TaskResult version.
type: string
example: W"1651505400036"
resourceType:
description: Resource type of the metadata subject.
type: string
example: TaskResult
schemas:
type: array
example:
- 'urn:ietf:params:scim:schemas:sailpoint:1.0:TaskResult'
/scim/v2/Users:
get:
operationId: getUsers
tags:
- Users
summary: Returns all User resources.
description: 'This endpoint returns all User resources. There are attributes marked as ''returned only by request'', such as **roles**, which must be provided as part of the **attributes** query parameter in order to be included in the response.'
parameters:
- in: query
name: filter
schema:
type: string
example: location eq "Raleigh" and name.givenName sw "j" and name.familyName sw "s"
description: 'Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported.'
- in: query
name: sortBy
schema:
type: string
example: userName
description: Allows sorting the results by a resource's attributes.
- in: query
name: sortOrder
schema:
type: string
example: descending
default: ascending
description: Determines what order to sort results in.
- in: query
name: startIndex
schema:
type: integer
example: 2313
default: 1
description: Determines the starting index of the result set.
- in: query
name: count
schema:
type: integer
example: 10
default: 1000
description: Specifies the number of results per page.
- in: query
name: attributes
schema:
type: string
example: 'userName,nativeIdentity'
description: 'A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.'
- in: query
name: excludedAttributes
schema:
type: string
example: 'userName,manuallyCorrelated'
description: A comma-separated list of attributes to exclude from the response. *Some attributes cannot be excluded.*
responses:
'200':
description: Returns all SCIM User resources.
content:
application/json:
schema:
properties:
totalResults:
description: Number of User resources returned
type: integer
example: 18
startIndex:
description: The starting index of the resource set list. Can be specified with startIndex query parameter.
type: integer
example: 1
schemas:
description: SCIM Schema used for response.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:api:messages:2.0:ListResponse'
Resources:
type: array
items:
properties:
id:
description: IdentityIQ id of the User.
type: string
example: c0b4568a4fe7458c434ee77d1fbt156b
userName:
description: Unique identifier for the User. Typically used to directly authenticate to the service provider. Each User MUST include a non-empty userName value. This identifier MUST be unique across the entire set of Users. Cannot be changed.
type: string
example: Mock.User
name:
description: 'The components of the User’s real name. Providers may return just the full name as a single string in the formatted sub-attribute, or they MAY return just the individual component attributes using the other sub-attributes, or they MAY return both. If both variants are returned, they SHOULD be describing the same name, with the formatted name indicating how the component attributes should be combined.'
properties:
formatted:
description: 'The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.'
type: string
example: 'Ms. Barbara J Jensen, III'
familyName:
description: 'The family name of the User, or Last Name in most Western languages'
type: string
example: Jensen
givenName:
description: 'The given name of the User, or First Name in most Western languages'
type: string
example: Barbara
displayName:
description: 'The name of the User, suitable for display to end-users. The name should be the full name of the User being described.'
type: string
example: Barbara Jensen
userType:
description: 'The type of the User, identifying the relationship between the organization and the User.'
type: string
example: employee
active:
description: A Boolean value indicating the User’s administrative status.
type: boolean
example: true
emails:
description: 'Email addresses for the user. The value SHOULD be canonicalized by the Service Provider, e.g., bjensen@example.com instead of bjensen@EXAMPLE.COM. Canonical Type values of work, home, and other.'
type: array
items:
properties:
type:
description: 'Type of email address (work, home, other).'
type: string
example: work
value:
description: Canonicalized email address.
type: string
format: email
example: Barbara.Jensen@example.com
primary:
description: A Boolean value indicating the primary e-mail address. The primary attribute value 'true' MUST appear no more than once.
type: boolean
example: true
'urn:ietf:params:scim:schemas:sailpoint:1.0:User':
description: Additional attributes of the User.
type: object
properties:
accounts:
description: Simple representation of the Account (or Link) ResourceType.
type: array
items:
properties:
displayName:
description: The display name of the Account.
type: string
example: Bob.Smith
value:
description: The id of the SCIM resource representing the Account.
type: string
example: c0a7778b7ef71e79817ee74e6a1f0444
$ref:
description: The URI of the SCIM resource representing the Account.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Accounts/c0a7778b7ef71e79817ee74e6a1f0444'
entitlements:
description: Entitlements of the User. Returned in response only if requested using the 'attributes' query parameter.
type: array
items:
properties:
value:
description: The value of the Entitlement.
type: string
example: groupmbr
display:
description: The display name of the Entitlement.
type: string
example: HelpDesk
type:
description: 'The type of Entitlement (Entitlement, Permission, etc.).'
type: string
example: Permission
application:
description: The name of the Application this Entitlement applies to.
type: string
example: ADMockApp
accountName:
description: The account this Entitlement was sourced from.
type: string
example: 'CN=Barbara Jensen,OU=Taipei,OU=Asia-Pacific,DC=example,DC=com'
$ref:
description: The URI of the SCIM resource representing the Entitlement.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Entitlements/c0a7777a7f74744d817e74fc12362c67'
roles:
description: Roles of the User. Returned only if requested. Returned in response only if requested using the 'attributes' query parameter.
type: array
items:
properties:
value:
description: The value of the Role.
type: string
example: detectedRoles
display:
description: The display name of the Role.
type: string
example: User - IT
type:
description: 'The type of Role (IT, Business, etc.).'
type: string
example: it
acquired:
description: Indicates how this Role was acquired. Assigned or Detected.
type: string
example: Assigned
application:
description: The name of the Application where this Role came from.
type: string
example: Active_Directory
accountName:
description: The name of the Account this Role was sourced from.
type: string
example: 'CN=Barbara Jensen,OU=Taipei,OU=Asia-Pacific,DC=example,DC=com'
$ref:
description: The URI of the SCIM resource representing the Role.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Roles/c0a7777a7f74744d817e74fc12362c67'
capabilities:
description: Capabilities assigned to this User.
type: array
items:
type: string
example: ['SystemAdministrator']
riskScore:
description: Composite Risk Score of this User.
type: integer
example: 125
isManager:
description: A Boolean value that determines if this User is a manager.
type: boolean
example: false
administrator:
description: The Administrator of the RPA or Service Account. This attribute is only applicable if the User type is RPA/Bots or Service.
properties:
displayName:
description: The display name of the Administrator of RPA user or Service account.
type: string
example: Bob Smith
value:
description: The id of the SCIM resource representing the Administrator of RPA user or Service account.
type: string
example: c0a7777a7f74744d817e74fc12362c67O
$ref:
description: The URI of the SCIM resource representing the Administrator of RPA user or Service Account.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0a7777a7f74744d817e74fc12362c67'
softwareVersion:
description: The software version of the RPA/Bots.
type: string
example: '7.3'
empId:
description: Employee id associated with this User.
type: string
example: 1b2a3c
dn:
description: Distinguished name for this User.
type: string
example: 'cn=Bob Smith,ou=services'
region:
description: The region this User is assigned to.
type: string
example: Americas
regionOwner:
description: The User who owns the region that this resource (User) belongs to.
properties:
displayName:
description: Display name of the region owner.
type: string
example: Joe Smith
value:
description: The id of the region owner.
type: string
example: c0b4568a4fe7458c434ee77d1fbt156b
$ref:
description: URI reference of the region owner resource.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b'
location:
description: The location this User is assigned to.
type: string
example: Singapore
locationOwner:
description: The User who owns the location that this resource (User) belongs to.
type: object
properties:
displayName:
description: Display name of the location owner.
type: string
example: Bob Smith
value:
description: The id of the location owner.
type: string
example: c0a7778b7ef71e79817ee74e6a1f0444
$ref:
description: URI reference to the location owner resource.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444'
Department:
description: Department this User is assigned to.
type: string
example: Regional Operations
costcenter:
description: Cost centers this User is associated with.
type: array
items:
type: string
example:
- CC01
- DD02
jobtitle:
description: Job title given to this User.
type: string
example: Internal Audit Manager
lastRefresh:
description: Datetime representation of the last refresh for this User.
type: string
format: date-time
'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User':
description: Enterprise User Schema. Contains the manager of the User.
properties:
manager:
description: Manager of the User.
properties:
displayName:
description: Display name of the User's manager.
type: string
example: Bob Smith
value:
description: The id of the SCIM resource representing the User’s manager.
type: string
example: c7a7347a7fe71e69077ee75f5d1f1237
$ref:
description: The URI of the SCIM resource representing the User’s manager.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c7a7347a7fe71e69077ee75f5d1f1237'
meta:
description: Metadata of the resource.
properties:
created:
description: Datetime this resource was created.
type: string
format: date-time
example: '2022-02-11T01:34:04.074-05:00'
location:
description: The location of the resource.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b'
lastModified:
description: Datetime the resource was last modified.
type: string
format: date-time
example: '2022-02-11T01:08:45.866-05:00'
version:
description: The version of the resource.
type: string
example: W"1644561244074"
resourceType:
description: The SCIM resource type.
type: string
example: User
schemas:
description: The schemas involved in the SCIM resource.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:schemas:sailpoint:1.0:User'
- 'urn:ietf:params:scim:schemas:core:2.0:User'
- 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User'
application/scim+json:
schema:
properties:
totalResults:
description: Number of User resources returned.
type: integer
example: '1500,'
startIndex:
description: The starting index of the resource set list. Can be specified with startIndex query parameter.
type: integer
example: 1
schemas:
description: SCIM Schema used for response.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:api:messages:2.0:ListResponse'
Resources:
description: The SCIM resources returned for this endpoint.
type: array
items:
properties:
id:
description: IdentityIQ id of the User.
type: string
example: c0b4568a4fe7458c434ee77d1fbt156b
userName:
description: Unique identifier for the User. Typically used to directly authenticate to the service provider. Each User MUST include a non-empty userName value. This identifier MUST be unique across the entire set of Users. Cannot be changed.
type: string
example: Mock.User
name:
description: 'The components of the User’s real name. Providers may return just the full name as a single string in the formatted sub-attribute, or they MAY return just the individual component attributes using the other sub-attributes, or they MAY return both. If both variants are returned, they SHOULD be describing the same name, with the formatted name indicating how the component attributes should be combined.'
properties:
formatted:
description: 'The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.'
type: string
example: 'Ms. Barbara J Jensen, III'
familyName:
description: 'The family name of the User, or Last Name in most Western languages'
type: string
example: Jensen
givenName:
description: 'The given name of the User, or First Name in most Western languages'
type: string
example: Barbara
displayName:
description: 'The name of the User, suitable for display to end-users. The name should be the full name of the User being described.'
type: string
example: Barbara Jensen
userType:
description: 'The type of the User, identifying the relationship between the organization and the User.'
type: string
example: employee
active:
description: A Boolean value indicating the User’s administrative status.
type: boolean
example: true
emails:
description: 'Email addresses for the user. The value SHOULD be canonicalized by the Service Provider, e.g., bjensen@example.com instead of bjensen@EXAMPLE.COM. Canonical Type values of work, home, and other.'
type: array
items:
properties:
type:
description: 'Type of email address (work, home, other).'
type: string
example: work
value:
description: Canonicalized email address.
type: string
format: email
example: Barbara.Jensen@example.com
primary:
description: A Boolean value indicating the primary e-mail address. The primary attribute value 'true' MUST appear no more than once.
type: boolean
example: 'true'
'urn:ietf:params:scim:schemas:sailpoint:1.0:User':
description: Additional attributes of the User.
type: object
properties:
accounts:
description: Simple representation of the Account (or Link) ResourceType.
type: array
items:
properties:
displayName:
description: The display name of the Account.
type: string
example: Bob.Smith
value:
description: The id of the SCIM resource representing the Account.
type: string
example: c0a7778b7ef71e79817ee74e6a1f0444
$ref:
description: The URI of the SCIM resource representing the Account.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Accounts/c0a7778b7ef71e79817ee74e6a1f0444'
entitlements:
description: Entitlements of the User. Returned in response only if requested using the 'attributes' query parameter.
type: array
items:
properties:
value:
description: The value of the Entitlement.
type: string
example: groupmbr
display:
description: The display name of the Entitlement.
type: string
example: HelpDesk
type:
description: 'The type of Entitlement (Entitlement, Permission, etc.).'
type: string
example: Permission
application:
description: The name of the Application this Entitlement applies to.
type: string
example: ADMockApp
accountName:
description: The account this Entitlement was sourced from.
type: string
example: 'CN=Barbara Jensen,OU=Taipei,OU=Asia-Pacific,DC=example,DC=com'
$ref:
description: The URI of the SCIM resource representing the Entitlement.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Entitlements/c0a7777a7f74744d817e74fc12362c67'
roles:
description: Roles of the User. Returned only if requested. Returned in response only if requested using the 'attributes' query parameter.
type: array
items:
properties:
value:
description: The value of the Role.
type: string
example: detectedRoles
display:
description: The display name of the Role.
type: string
example: User - IT
type:
description: 'The type of Role (IT, Business, etc.).'
type: string
example: it
acquired:
description: Indicates how this Role was acquired. Assigned or Detected.
type: string
example: Assigned
application:
description: The name of the Application where this Role came from.
type: string
example: Active_Directory
accountName:
description: The name of the Account this Role was sourced from.
type: string
example: 'CN=Barbara Jensen,OU=Taipei,OU=Asia-Pacific,DC=example,DC=com'
$ref:
description: The URI of the SCIM resource representing the Role.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Roles/c0a7777a7f74744d817e74fc12362c67'
capabilities:
description: Capabilities assigned to this User.
type: array
items:
type: string
example: '["SystemAdministrator"]'
riskScore:
description: Composite Risk Score of this User.
type: integer
example: 125
isManager:
description: A Boolean value that determines if this User is a manager.
type: boolean
example: false
administrator:
description: The Administrator of the RPA or Service Account. This attribute is only applicable if the User type is RPA/Bots or Service.
properties:
displayName:
description: The display name of the Administrator of RPA user or Service account.
type: string
example: Bob Smith
value:
description: The id of the SCIM resource representing the Administrator of RPA user or Service account.
type: string
example: c0a7777a7f74744d817e74fc12362c67O
$ref:
description: The URI of the SCIM resource representing the Administrator of RPA user or Service Account.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0a7777a7f74744d817e74fc12362c67'
softwareVersion:
description: The software version of the RPA/Bots.
type: string
example: '7.3'
empId:
description: Employee id associated with this User.
type: string
example: 1b2a3c
dn:
description: Distinguished name for this User.
type: string
example: 'cn=Bob Smith,ou=services'
region:
description: The region this User is assigned to.
type: string
example: Americas
regionOwner:
description: The User who owns the region that this resource (User) belongs to.
properties:
displayName:
description: Display name of the region owner.
type: string
example: Joe Smith
value:
description: The id of the region owner.
type: string
example: c0b4568a4fe7458c434ee77d1fbt156b
$ref:
description: URI reference of the region owner resource.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b'
location:
description: The location this User is assigned to.
type: string
example: Singapore
locationOwner:
description: The User who owns the location that this resource (User) belongs to.
type: object
properties:
displayName:
description: Display name of the location owner.
type: string
example: Bob Smith
value:
description: The id of the location owner.
type: string
example: c0a7778b7ef71e79817ee74e6a1f0444
$ref:
description: URI reference to the location owner resource.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444'
Department:
description: Department this User is assigned to.
type: string
example: Regional Operations
costcenter:
description: Cost centers this User is associated with.
type: array
items:
type: string
example:
- CC01
- DD02
jobtitle:
description: Job title given to this User.
type: string
example: Internal Audit Manager
lastRefresh:
description: Datetime representation of the last refresh for this User.
type: string
format: date-time
'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User':
description: Enterprise User Schema. Contains the manager of the User.
properties:
manager:
description: Manager of the User.
properties:
displayName:
description: Display name of the User's manager.
type: string
example: Bob Smith
value:
description: The id of the SCIM resource representing the User’s manager.
type: string
example: c7a7347a7fe71e69077ee75f5d1f1237
$ref:
description: The URI of the SCIM resource representing the User’s manager.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c7a7347a7fe71e69077ee75f5d1f1237'
meta:
description: Metadata of the resource.
properties:
created:
description: Datetime this resource was created.
type: string
format: date-time
example: '2022-02-11T01:34:04.074-05:00'
location:
description: The location of the resource.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b'
lastModified:
description: Datetime the resource was last modified.
type: string
format: date-time
example: '2022-02-11T01:08:45.866-05:00'
version:
description: The version of the resource.
type: string
example: W"1644561244074"
resourceType:
description: The SCIM resource type.
type: string
example: User
schemas:
description: The schemas involved in the SCIM resource.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:schemas:sailpoint:1.0:User'
- 'urn:ietf:params:scim:schemas:core:2.0:User'
- 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User'
post:
operationId: createUser
tags:
- Users
summary: Creates a User.
description: 'The endpoint used to create a User resource. There are attributes marked as ''returned only by request'', such as **roles**, which must be provided as part of the **attributes** query parameter in order to be included in the response.'
parameters:
- in: query
name: attributes
schema:
type: string
example: 'userName,nativeIdentity'
description: 'A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.'
- in: query
name: excludedAttributes
schema:
type: string
example: 'userName,manuallyCorrelated'
description: A comma-separated list of attributes to exclude from the response. *Some attributes cannot be excluded.*
requestBody:
required: true
content:
application/scim+json:
schema:
properties:
userName:
description: Unique identifier for the User. Typically used to directly authenticate to the service provider. Each User MUST include a non-empty userName value. This identifier MUST be unique across the entire set of Users. This attribute cannot be changed.
type: string
example: Mock.User
name:
description: 'The components of the User’s real name. Providers may return just the full name as a single string in the formatted sub-attribute, or they MAY return just the individual component attributes using the other sub-attributes, or they MAY return both. If both variants are returned, they SHOULD be describing the same name, with the formatted name indicating how the component attributes should be combined.'
properties:
formatted:
description: 'The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.'
type: string
example: 'Ms. Barbara J Jensen, III'
familyName:
description: 'The family name of the User, or Last Name in most Western languages'
type: string
example: Jensen
givenName:
description: 'The given name of the User, or First Name in most Western languages'
type: string
example: Barbara
displayName:
description: 'The name of the User, suitable for display to end-users. The name should be the full name of the User being described.'
type: string
example: Barbara Jensen
userType:
description: 'The type of the User, identifying the relationship between the organization and the User.'
type: string
example: employee
active:
description: A Boolean value indicating the User’s administrative status.
type: boolean
example: true
password:
description: The User's case-sensitive cleartext password. This attribute is intended to be used as a means to specify an initial password when creating a new User or to reset an existing User's password. This attribute will never be returned in a response.
type: string
emails:
description: 'Email addresses for the user. The value SHOULD be canonicalized by the Service Provider, e.g., bjensen@example.com instead of bjensen@EXAMPLE.COM. Canonical Type values of work, home, and other.'
type: array
items:
properties:
type:
description: 'Type of email address (work, home, other).'
type: string
example: work
value:
description: Canonicalized email address.
type: string
format: email
example: Barbara.Jensen@example.com
primary:
description: A Boolean value indicating the primary e-mail address. The primary attribute value 'true' MUST appear no more than once.
type: boolean
example: 'true'
'urn:ietf:params:scim:schemas:sailpoint:1.0:User':
properties:
capabilities:
description: Capabilities assigned to this User.
type: array
items:
type: string
example: '["SystemAdministrator"]'
administrator:
description: The Administrator of the RPA or Service Account. This attribute is only applicable if the User type is RPA/Bots or Service.
properties:
displayName:
description: The display name of the Administrator of RPA user or Service account.
type: string
example: Bob Smith
value:
description: The id of the SCIM resource representing the Administrator of RPA user or Service account.
type: string
example: c0a7777a7f74744d817e74fc12362c67O
$ref:
description: The URI of the SCIM resource representing the Administrator of RPA user or Service Account.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0a7777a7f74744d817e74fc12362c67'
softwareVersion:
description: The software version of the RPA/Bots.
type: string
example: '7.3'
empId:
description: Employee id associated with this User.
type: string
example: 1b2a3c
dn:
description: Distinguished name for this User.
type: string
example: 'cn=Bob Smith,ou=services'
region:
description: The region this User is assigned to.
type: string
example: Americas
regionOwner:
description: The User who owns the region that this resource (User) belongs to.
properties:
displayName:
description: Display name of the region owner.
type: string
example: Joe Smith
value:
description: The id of the region owner.
type: string
example: c0b4568a4fe7458c434ee77d1fbt156b
$ref:
description: URI reference of the region owner resource.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b'
location:
description: The location this User is assigned to.
type: string
example: Singapore
locationOwner:
description: The User who owns the location that this resource (User) belongs to.
type: object
properties:
displayName:
description: Display name of the location owner.
type: string
example: Bob Smith
value:
description: The id of the location owner.
type: string
example: c0a7778b7ef71e79817ee74e6a1f0444
$ref:
description: URI reference to the location owner resource.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444'
Department:
description: Department this User is assigned to.
type: string
example: Regional Operations
costcenter:
description: Cost centers this User is associated with.
type: array
items:
type: string
example:
- CC01
- DD02
jobtitle:
description: Job title given to this User.
type: string
example: Internal Audit Manager
'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User':
description: Enterprise User Schema. Contains the manager of the User.
properties:
manager:
description: Manager of the user.
properties:
displayName:
description: Display name of the manager.
type: string
example: Bob Smith
value:
description: The id of the manager.
type: string
example: c7a7347a7fe71e69077ee75f5d1f1237
$ref:
description: Reference to the manager resource.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c7a7347a7fe71e69077ee75f5d1f1237'
required:
- userName
'*/*':
schema:
properties:
userName:
description: Unique identifier for the User. Typically used to directly authenticate to the service provider. Each User MUST include a non-empty userName value. This identifier MUST be unique across the entire set of Users. This attribute cannot be changed.
type: string
example: Mock.User
name:
description: 'The components of the User’s real name. Providers may return just the full name as a single string in the formatted sub-attribute, or they MAY return just the individual component attributes using the other sub-attributes, or they MAY return both. If both variants are returned, they SHOULD be describing the same name, with the formatted name indicating how the component attributes should be combined.'
properties:
formatted:
description: 'The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.'
type: string
example: 'Ms. Barbara J Jensen, III'
familyName:
description: 'The family name of the User, or Last Name in most Western languages'
type: string
example: Jensen
givenName:
description: 'The given name of the User, or First Name in most Western languages'
type: string
example: Barbara
displayName:
description: 'The name of the User, suitable for display to end-users. The name should be the full name of the User being described.'
type: string
example: Barbara Jensen
userType:
description: 'The type of the User, identifying the relationship between the organization and the User.'
type: string
example: employee
active:
description: A Boolean value indicating the User’s administrative status.
type: boolean
example: true
password:
description: The User's case-sensitive cleartext password. This attribute is intended to be used as a means to specify an initial password when creating a new User or to reset an existing User's password. This attribute will never be returned in a response.
type: string
emails:
description: 'Email addresses for the user. The value SHOULD be canonicalized by the Service Provider, e.g., bjensen@example.com instead of bjensen@EXAMPLE.COM. Canonical Type values of work, home, and other.'
type: array
items:
properties:
type:
description: 'Type of email address (work, home, other).'
type: string
example: work
value:
description: Canonicalized email address.
type: string
format: email
example: Barbara.Jensen@example.com
primary:
description: A Boolean value indicating the primary e-mail address. The primary attribute value 'true' MUST appear no more than once.
type: boolean
example: 'true'
'urn:ietf:params:scim:schemas:sailpoint:1.0:User':
properties:
capabilities:
description: Capabilities assigned to this User.
type: array
items:
type: string
example: '["SystemAdministrator"]'
administrator:
description: The Administrator of the RPA or Service Account. This attribute is only applicable if the User type is RPA/Bots or Service.
properties:
displayName:
description: The display name of the Administrator of RPA user or Service account.
type: string
example: Bob Smith
value:
description: The id of the SCIM resource representing the Administrator of RPA user or Service account.
type: string
example: c0a7777a7f74744d817e74fc12362c67O
$ref:
description: The URI of the SCIM resource representing the Administrator of RPA user or Service Account.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0a7777a7f74744d817e74fc12362c67'
softwareVersion:
description: The software version of the RPA/Bots.
type: string
example: '7.3'
empId:
description: Employee id associated with this User.
type: string
example: 1b2a3c
dn:
description: Distinguished name for this User.
type: string
example: 'cn=Bob Smith,ou=services'
region:
description: The region this User is assigned to.
type: string
example: Americas
regionOwner:
description: The User who owns the region that this resource (User) belongs to.
properties:
displayName:
description: Display name of the region owner.
type: string
example: Joe Smith
value:
description: The id of the region owner.
type: string
example: c0b4568a4fe7458c434ee77d1fbt156b
$ref:
description: URI reference of the region owner resource.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b'
location:
description: The location this User is assigned to.
type: string
example: Singapore
locationOwner:
description: The User who owns the location that this resource (User) belongs to.
type: object
properties:
displayName:
description: Display name of the location owner.
type: string
example: Bob Smith
value:
description: The id of the location owner.
type: string
example: c0a7778b7ef71e79817ee74e6a1f0444
$ref:
description: URI reference to the location owner resource.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444'
Department:
description: Department this User is assigned to.
type: string
example: Regional Operations
costcenter:
description: Cost centers this User is associated with.
type: array
items:
type: string
example:
- CC01
- DD02
jobtitle:
description: Job title given to this User.
type: string
example: Internal Audit Manager
'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User':
description: Enterprise User Schema. Contains the manager of the User.
properties:
manager:
description: Manager of the user.
properties:
displayName:
description: Display name of the manager.
type: string
example: Bob Smith
value:
description: The id of the manager.
type: string
example: c7a7347a7fe71e69077ee75f5d1f1237
$ref:
description: Reference to the manager resource.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c7a7347a7fe71e69077ee75f5d1f1237'
required:
- userName
responses:
'201':
description: Creates a User and returns the resultant User.
content:
application/json:
schema:
properties:
id:
description: IdentityIQ id of the User.
type: string
example: c0b4568a4fe7458c434ee77d1fbt156b
userName:
description: Unique identifier for the User. Typically used to directly authenticate to the service provider. Each User MUST include a non-empty userName value. This identifier MUST be unique across the entire set of Users. Cannot be changed.
type: string
example: Mock.User
name:
description: 'The components of the User’s real name. Providers may return just the full name as a single string in the formatted sub-attribute, or they MAY return just the individual component attributes using the other sub-attributes, or they MAY return both. If both variants are returned, they SHOULD be describing the same name, with the formatted name indicating how the component attributes should be combined.'
properties:
formatted:
description: 'The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.'
type: string
example: 'Ms. Barbara J Jensen, III'
familyName:
description: 'The family name of the User, or Last Name in most Western languages'
type: string
example: Jensen
givenName:
description: 'The given name of the User, or First Name in most Western languages'
type: string
example: Barbara
displayName:
description: 'The name of the User, suitable for display to end-users. The name should be the full name of the User being described.'
type: string
example: Barbara Jensen
userType:
description: 'The type of the User, identifying the relationship between the organization and the User.'
type: string
example: employee
active:
description: A Boolean value indicating the User’s administrative status.
type: boolean
example: true
emails:
description: 'Email addresses for the user. The value SHOULD be canonicalized by the Service Provider, e.g., bjensen@example.com instead of bjensen@EXAMPLE.COM. Canonical Type values of work, home, and other.'
type: array
items:
properties:
type:
description: 'Type of email address (work, home, other).'
type: string
example: work
value:
description: Canonicalized email address.
type: string
format: email
example: Barbara.Jensen@example.com
primary:
description: A Boolean value indicating the primary e-mail address. The primary attribute value 'true' MUST appear no more than once.
type: boolean
example: 'true'
'urn:ietf:params:scim:schemas:sailpoint:1.0:User':
description: Additional attributes of the User.
type: object
properties:
accounts:
description: Simple representation of the Account (or Link) ResourceType.
type: array
items:
properties:
displayName:
description: The display name of the Account.
type: string
example: Bob.Smith
value:
description: The id of the SCIM resource representing the Account.
type: string
example: c0a7778b7ef71e79817ee74e6a1f0444
$ref:
description: The URI of the SCIM resource representing the Account.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Accounts/c0a7778b7ef71e79817ee74e6a1f0444'
entitlements:
description: Entitlements of the User. Returned in response only if requested using the 'attributes' query parameter.
type: array
items:
properties:
value:
description: The value of the Entitlement.
type: string
example: groupmbr
display:
description: The display name of the Entitlement.
type: string
example: HelpDesk
type:
description: 'The type of Entitlement (Entitlement, Permission, etc.).'
type: string
example: Permission
application:
description: The name of the Application this Entitlement applies to.
type: string
example: ADMockApp
accountName:
description: The account this Entitlement was sourced from.
type: string
example: 'CN=Barbara Jensen,OU=Taipei,OU=Asia-Pacific,DC=example,DC=com'
$ref:
description: The URI of the SCIM resource representing the Entitlement.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Entitlements/c0a7777a7f74744d817e74fc12362c67'
roles:
description: Roles of the User. Returned only if requested. Returned in response only if requested using the 'attributes' query parameter.
type: array
items:
properties:
value:
description: The value of the Role.
type: string
example: detectedRoles
display:
description: The display name of the Role.
type: string
example: User - IT
type:
description: 'The type of Role (IT, Business, etc.).'
type: string
example: it
acquired:
description: Indicates how this Role was acquired. Assigned or Detected.
type: string
example: Assigned
application:
description: The name of the Application where this Role came from.
type: string
example: Active_Directory
accountName:
description: The name of the Account this Role was sourced from.
type: string
example: 'CN=Barbara Jensen,OU=Taipei,OU=Asia-Pacific,DC=example,DC=com'
$ref:
description: The URI of the SCIM resource representing the Role.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Roles/c0a7777a7f74744d817e74fc12362c67'
capabilities:
description: Capabilities assigned to this User.
type: array
items:
type: string
example: '["SystemAdministrator"]'
riskScore:
description: Composite Risk Score of this User.
type: integer
example: 125
isManager:
description: A Boolean value that determines if this User is a manager.
type: boolean
example: false
administrator:
description: The Administrator of the RPA or Service Account. This attribute is only applicable if the User type is RPA/Bots or Service.
properties:
displayName:
description: The display name of the Administrator of RPA user or Service account.
type: string
example: Bob Smith
value:
description: The id of the SCIM resource representing the Administrator of RPA user or Service account.
type: string
example: c0a7777a7f74744d817e74fc12362c67O
$ref:
description: The URI of the SCIM resource representing the Administrator of RPA user or Service Account.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0a7777a7f74744d817e74fc12362c67'
softwareVersion:
description: The software version of the RPA/Bots.
type: string
example: '7.3'
empId:
description: Employee id associated with this User.
type: string
example: 1b2a3c
dn:
description: Distinguished name for this User.
type: string
example: 'cn=Bob Smith,ou=services'
region:
description: The region this User is assigned to.
type: string
example: Americas
regionOwner:
description: The User who owns the region that this resource (User) belongs to.
properties:
displayName:
description: Display name of the region owner.
type: string
example: Joe Smith
value:
description: The id of the region owner.
type: string
example: c0b4568a4fe7458c434ee77d1fbt156b
$ref:
description: URI reference of the region owner resource.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b'
location:
description: The location this User is assigned to.
type: string
example: Singapore
locationOwner:
description: The User who owns the location that this resource (User) belongs to.
type: object
properties:
displayName:
description: Display name of the location owner.
type: string
example: Bob Smith
value:
description: The id of the location owner.
type: string
example: c0a7778b7ef71e79817ee74e6a1f0444
$ref:
description: URI reference to the location owner resource.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444'
Department:
description: Department this User is assigned to.
type: string
example: Regional Operations
costcenter:
description: Cost centers this User is associated with.
type: array
items:
type: string
example:
- CC01
- DD02
jobtitle:
description: Job title given to this User.
type: string
example: Internal Audit Manager
lastRefresh:
description: Datetime representation of the last refresh for this User.
type: string
format: date-time
'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User':
description: Enterprise User Schema. Contains the manager of the User.
properties:
manager:
description: Manager of the User.
properties:
displayName:
description: Display name of the User's manager.
type: string
example: Bob Smith
value:
description: The id of the SCIM resource representing the User’s manager.
type: string
example: c7a7347a7fe71e69077ee75f5d1f1237
$ref:
description: The URI of the SCIM resource representing the User’s manager.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c7a7347a7fe71e69077ee75f5d1f1237'
meta:
description: Metadata of the resource.
properties:
created:
description: Datetime this resource was created.
type: string
format: date-time
example: '2022-02-11T01:34:04.074-05:00'
location:
description: The location of the resource.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b'
lastModified:
description: Datetime the resource was last modified.
type: string
format: date-time
example: '2022-02-11T01:08:45.866-05:00'
version:
description: The version of the resource.
type: string
example: W"1644561244074"
resourceType:
description: The SCIM resource type.
type: string
example: User
schemas:
description: The schemas involved in the SCIM resource.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:schemas:sailpoint:1.0:User'
- 'urn:ietf:params:scim:schemas:core:2.0:User'
- 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User'
'409':
description: Returned if userName is not unique.
content:
application/json:
schema:
properties:
schemas:
description: SCIM Schemas used in response.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:api:messages:2.0:Error'
scimType:
description: Type of problem that exists for request.
type: string
example: uniqueness
detail:
description: Explanation for the the problem with the request.
type: string
example: 'Resource already exists:Mock.User'
status:
description: HTTP status code of the response.
type: string
example: '409'
'/scim/v2/Users/{userId}':
get:
operationId: getUserById
tags:
- Users
summary: Returns a User resource based on id.
description: 'The User resource with matching id is returned. There are attributes marked as ''returned only by request'', such as **roles**, which must be provided as part of the **attributes** query parameter in order to be included in the response.'
parameters:
- name: userId
in: path
schema:
type: string
example: c7c7777c7ef77e77777ee77e7a1f0444
description: 'The id of User resource. If **lookupByName** is set to **true**, this path parameter should be set to the **userName** of the User.'
required: true
- in: query
name: attributes
schema:
type: string
example: 'userName,nativeIdentity'
description: 'A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.'
- in: query
name: excludedAttributes
schema:
type: string
example: 'userName,manuallyCorrelated'
description: A comma-separated list of attributes to exclude from the response. *Some attributes cannot be excluded.*
- in: query
name: lookupByName
schema:
type: boolean
example: false
default: false
description: 'A boolean value that determines if the User resource will be looked up by userName instead of userId (value in path parameter ''userId''). Setting this query parameter to true will cause the value pulled from the ''userId'' path parameter to be treated as a userName when searching for the resource.
**Example**: scim/v2/Users/**Mock.User**?**lookupByName=true**'
responses:
'200':
description: Returns a single User resource based on the id.
content:
application/json:
schema:
properties:
id:
description: IdentityIQ id of the User.
type: string
example: c0b4568a4fe7458c434ee77d1fbt156b
userName:
description: Unique identifier for the User. Typically used to directly authenticate to the service provider. Each User MUST include a non-empty userName value. This identifier MUST be unique across the entire set of Users. Cannot be changed.
type: string
example: Mock.User
name:
description: 'The components of the User’s real name. Providers may return just the full name as a single string in the formatted sub-attribute, or they MAY return just the individual component attributes using the other sub-attributes, or they MAY return both. If both variants are returned, they SHOULD be describing the same name, with the formatted name indicating how the component attributes should be combined.'
properties:
formatted:
description: 'The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.'
type: string
example: 'Ms. Barbara J Jensen, III'
familyName:
description: 'The family name of the User, or Last Name in most Western languages'
type: string
example: Jensen
givenName:
description: 'The given name of the User, or First Name in most Western languages'
type: string
example: Barbara
displayName:
description: 'The name of the User, suitable for display to end-users. The name should be the full name of the User being described.'
type: string
example: Barbara Jensen
userType:
description: 'The type of the User, identifying the relationship between the organization and the User.'
type: string
example: employee
active:
description: A Boolean value indicating the User’s administrative status.
type: boolean
example: true
emails:
description: 'Email addresses for the user. The value SHOULD be canonicalized by the Service Provider, e.g., bjensen@example.com instead of bjensen@EXAMPLE.COM. Canonical Type values of work, home, and other.'
type: array
items:
properties:
type:
description: 'Type of email address (work, home, other).'
type: string
example: work
value:
description: Canonicalized email address.
type: string
format: email
example: Barbara.Jensen@example.com
primary:
description: A Boolean value indicating the primary e-mail address. The primary attribute value 'true' MUST appear no more than once.
type: boolean
example: 'true'
'urn:ietf:params:scim:schemas:sailpoint:1.0:User':
description: Additional attributes of the User.
type: object
properties:
accounts:
description: Simple representation of the Account (or Link) ResourceType.
type: array
items:
properties:
displayName:
description: The display name of the Account.
type: string
example: Bob.Smith
value:
description: The id of the SCIM resource representing the Account.
type: string
example: c0a7778b7ef71e79817ee74e6a1f0444
$ref:
description: The URI of the SCIM resource representing the Account.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Accounts/c0a7778b7ef71e79817ee74e6a1f0444'
capabilities:
description: Capabilities assigned to this User.
type: array
items:
type: string
example: '["SystemAdministrator"]'
riskScore:
description: Composite Risk Score of this User.
type: integer
example: 125
isManager:
description: A Boolean value that determines if this User is a manager.
type: boolean
example: false
administrator:
description: The Administrator of the RPA or Service Account. This attribute is only applicable if the User type is RPA/Bots or Service.
properties:
displayName:
description: The display name of the Administrator of RPA user or Service account.
type: string
example: Bob Smith
value:
description: The id of the SCIM resource representing the Administrator of RPA user or Service account.
type: string
example: c0a7777a7f74744d817e74fc12362c67O
$ref:
description: The URI of the SCIM resource representing the Administrator of RPA user or Service Account.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0a7777a7f74744d817e74fc12362c67'
softwareVersion:
description: The software version of the RPA/Bots.
type: string
example: '7.3'
empId:
description: Employee id associated with this User.
type: string
example: 1b2a3c
dn:
description: Distinguished name for this User.
type: string
example: 'cn=Bob Smith,ou=services'
region:
description: The region this User is assigned to.
type: string
example: Americas
regionOwner:
description: The User who owns the region that this resource (User) belongs to.
properties:
displayName:
description: Display name of the region owner.
type: string
example: Joe Smith
value:
description: The id of the region owner.
type: string
example: c0b4568a4fe7458c434ee77d1fbt156b
$ref:
description: URI reference of the region owner resource.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b'
location:
description: The location this User is assigned to.
type: string
example: Singapore
locationOwner:
description: The User who owns the location that this resource (User) belongs to.
type: object
properties:
displayName:
description: Display name of the location owner.
type: string
example: Bob Smith
value:
description: The id of the location owner.
type: string
example: c0a7778b7ef71e79817ee74e6a1f0444
$ref:
description: URI reference to the location owner resource.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444'
Department:
description: Department this User is assigned to.
type: string
example: Regional Operations
costcenter:
description: Cost centers this User is associated with.
type: array
items:
type: string
example:
- CC01
- DD02
jobtitle:
description: Job title given to this User.
type: string
example: Internal Audit Manager
lastRefresh:
description: Datetime representation of the last refresh for this User.
type: string
format: date-time
'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User':
description: Enterprise User Schema. Contains the manager of the User.
properties:
manager:
description: Manager of the User.
properties:
displayName:
description: Display name of the User's manager.
type: string
example: Bob Smith
value:
description: The id of the SCIM resource representing the User’s manager.
type: string
example: c7a7347a7fe71e69077ee75f5d1f1237
$ref:
description: The URI of the SCIM resource representing the User’s manager.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c7a7347a7fe71e69077ee75f5d1f1237'
meta:
description: Metadata of the resource.
properties:
created:
description: Datetime this resource was created.
type: string
format: date-time
example: '2022-02-11T01:34:04.074-05:00'
location:
description: The location of the resource.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b'
lastModified:
description: Datetime the resource was last modified.
type: string
format: date-time
example: '2022-02-11T01:08:45.866-05:00'
version:
description: The version of the resource.
type: string
example: W"1644561244074"
resourceType:
description: The SCIM resource type.
type: string
example: User
schemas:
description: The schemas involved in the SCIM resource.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:schemas:sailpoint:1.0:User'
- 'urn:ietf:params:scim:schemas:core:2.0:User'
- 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User'
application/scim+json:
schema:
properties:
id:
description: IdentityIQ id of the User.
type: string
example: c0b4568a4fe7458c434ee77d1fbt156b
userName:
description: Unique identifier for the User. Typically used to directly authenticate to the service provider. Each User MUST include a non-empty userName value. This identifier MUST be unique across the entire set of Users. Cannot be changed.
type: string
example: Mock.User
name:
description: 'The components of the User’s real name. Providers may return just the full name as a single string in the formatted sub-attribute, or they MAY return just the individual component attributes using the other sub-attributes, or they MAY return both. If both variants are returned, they SHOULD be describing the same name, with the formatted name indicating how the component attributes should be combined.'
properties:
formatted:
description: 'The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.'
type: string
example: 'Ms. Barbara J Jensen, III'
familyName:
description: 'The family name of the User, or Last Name in most Western languages'
type: string
example: Jensen
givenName:
description: 'The given name of the User, or First Name in most Western languages'
type: string
example: Barbara
displayName:
description: 'The name of the User, suitable for display to end-users. The name should be the full name of the User being described.'
type: string
example: Barbara Jensen
userType:
description: 'The type of the User, identifying the relationship between the organization and the User.'
type: string
example: employee
active:
description: A Boolean value indicating the User’s administrative status.
type: boolean
example: true
emails:
description: 'Email addresses for the user. The value SHOULD be canonicalized by the Service Provider, e.g., bjensen@example.com instead of bjensen@EXAMPLE.COM. Canonical Type values of work, home, and other.'
type: array
items:
properties:
type:
description: 'Type of email address (work, home, other).'
type: string
example: work
value:
description: Canonicalized email address.
type: string
format: email
example: Barbara.Jensen@example.com
primary:
description: A Boolean value indicating the primary e-mail address. The primary attribute value 'true' MUST appear no more than once.
type: boolean
example: 'true'
'urn:ietf:params:scim:schemas:sailpoint:1.0:User':
description: Additional attributes of the User.
type: object
properties:
accounts:
description: Simple representation of the Account (or Link) ResourceType.
type: array
items:
properties:
displayName:
description: The display name of the Account.
type: string
example: Bob.Smith
value:
description: The id of the SCIM resource representing the Account.
type: string
example: c0a7778b7ef71e79817ee74e6a1f0444
$ref:
description: The URI of the SCIM resource representing the Account.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Accounts/c0a7778b7ef71e79817ee74e6a1f0444'
entitlements:
description: Entitlements of the User. Returned in response only if requested using the 'attributes' query parameter.
type: array
items:
properties:
value:
description: The value of the Entitlement.
type: string
example: groupmbr
display:
description: The display name of the Entitlement.
type: string
example: HelpDesk
type:
description: 'The type of Entitlement (Entitlement, Permission, etc.).'
type: string
example: Permission
application:
description: The name of the Application this Entitlement applies to.
type: string
example: ADMockApp
accountName:
description: The account this Entitlement was sourced from.
type: string
example: 'CN=Barbara Jensen,OU=Taipei,OU=Asia-Pacific,DC=example,DC=com'
$ref:
description: The URI of the SCIM resource representing the Entitlement.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Entitlements/c0a7777a7f74744d817e74fc12362c67'
roles:
description: Roles of the User. Returned only if requested. Returned in response only if requested using the 'attributes' query parameter.
type: array
items:
properties:
value:
description: The value of the Role.
type: string
example: detectedRoles
display:
description: The display name of the Role.
type: string
example: User - IT
type:
description: 'The type of Role (IT, Business, etc.).'
type: string
example: it
acquired:
description: Indicates how this Role was acquired. Assigned or Detected.
type: string
example: Assigned
application:
description: The name of the Application where this Role came from.
type: string
example: Active_Directory
accountName:
description: The name of the Account this Role was sourced from.
type: string
example: 'CN=Barbara Jensen,OU=Taipei,OU=Asia-Pacific,DC=example,DC=com'
$ref:
description: The URI of the SCIM resource representing the Role.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Roles/c0a7777a7f74744d817e74fc12362c67'
capabilities:
description: Capabilities assigned to this User.
type: array
items:
type: string
example: '["SystemAdministrator"]'
riskScore:
description: Composite Risk Score of this User.
type: integer
example: 125
isManager:
description: A Boolean value that determines if this User is a manager.
type: boolean
example: false
administrator:
description: The Administrator of the RPA or Service Account. This attribute is only applicable if the User type is RPA/Bots or Service.
properties:
displayName:
description: The display name of the Administrator of RPA user or Service account.
type: string
example: Bob Smith
value:
description: The id of the SCIM resource representing the Administrator of RPA user or Service account.
type: string
example: c0a7777a7f74744d817e74fc12362c67O
$ref:
description: The URI of the SCIM resource representing the Administrator of RPA user or Service Account.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0a7777a7f74744d817e74fc12362c67'
softwareVersion:
description: The software version of the RPA/Bots.
type: string
example: '7.3'
empId:
description: Employee id associated with this User.
type: string
example: 1b2a3c
dn:
description: Distinguished name for this User.
type: string
example: 'cn=Bob Smith,ou=services'
region:
description: The region this User is assigned to.
type: string
example: Americas
regionOwner:
description: The User who owns the region that this resource (User) belongs to.
properties:
displayName:
description: Display name of the region owner.
type: string
example: Joe Smith
value:
description: The id of the region owner.
type: string
example: c0b4568a4fe7458c434ee77d1fbt156b
$ref:
description: URI reference of the region owner resource.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b'
location:
description: The location this User is assigned to.
type: string
example: Singapore
locationOwner:
description: The User who owns the location that this resource (User) belongs to.
type: object
properties:
displayName:
description: Display name of the location owner.
type: string
example: Bob Smith
value:
description: The id of the location owner.
type: string
example: c0a7778b7ef71e79817ee74e6a1f0444
$ref:
description: URI reference to the location owner resource.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444'
Department:
description: Department this User is assigned to.
type: string
example: Regional Operations
costcenter:
description: Cost centers this User is associated with.
type: array
items:
type: string
example:
- CC01
- DD02
jobtitle:
description: Job title given to this User.
type: string
example: Internal Audit Manager
lastRefresh:
description: Datetime representation of the last refresh for this User.
type: string
format: date-time
'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User':
description: Enterprise User Schema. Contains the manager of the User.
properties:
manager:
description: Manager of the User.
properties:
displayName:
description: Display name of the User's manager.
type: string
example: Bob Smith
value:
description: The id of the SCIM resource representing the User’s manager.
type: string
example: c7a7347a7fe71e69077ee75f5d1f1237
$ref:
description: The URI of the SCIM resource representing the User’s manager.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c7a7347a7fe71e69077ee75f5d1f1237'
meta:
description: Metadata of the resource.
properties:
created:
description: Datetime this resource was created.
type: string
format: date-time
example: '2022-02-11T01:34:04.074-05:00'
location:
description: The location of the resource.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b'
lastModified:
description: Datetime the resource was last modified.
type: string
format: date-time
example: '2022-02-11T01:08:45.866-05:00'
version:
description: The version of the resource.
type: string
example: W"1644561244074"
resourceType:
description: The SCIM resource type.
type: string
example: User
schemas:
description: The schemas involved in the SCIM resource.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:schemas:sailpoint:1.0:User'
- 'urn:ietf:params:scim:schemas:core:2.0:User'
- 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User'
put:
operationId: updateUser
tags:
- Users
summary: Updates an existing User.
description: 'The endpoint used to update a User resource. There are attributes marked as ''returned only by request'', such as **roles**, which must be provided as part of the **attributes** query parameter in order to be included in the response.
In order for Lifecycle Events to have access to previous Identity values, a new IdentityArchive object is created and saved to the database. This feature is turned on by default and *could* have an impact on the overall performance of the SCIM update. It is not expected for the impact of this change to be noticeable, but in cases where it is, and when configured Lifecycle Events are not dependent on the previous Identity attributes, the creation of the IdentityArchive object during a SCIM update is configurable. By default, the IdentityArchive creation during a SCIM update is enabled. To disable the creation of the IdentityArchive object during SCIM updates, the following attribute can be set on the SystemConfiguration object:
**<entry key="scimTriggerSnapshots" value="false">**'
parameters:
- name: userId
in: path
schema:
type: string
example: c7c7777c7ef77e77777ee77e7a1f0444
description: 'The id of User resource. If **lookupByName** is set to **true**, this path parameter should be set to the **userName** of the User.'
required: true
- in: query
name: attributes
schema:
type: string
description: 'A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.'
- in: query
name: excludedAttributes
schema:
type: string
description: A comma-separated list of attributes to exclude from the response. *Some attributes cannot be excluded.*
- in: query
name: lookupByName
schema:
type: boolean
example: false
default: false
description: 'A boolean value that determines if the User resource will be looked up by userName instead of userId (value in path parameter ''userId''). Setting this query parameter to true will cause the value pulled from the ''userId'' path parameter to be treated as a userName when searching for the resource.
**Example**: scim/v2/Users/**Mock.User**?**lookupByName=true**'
requestBody:
required: true
content:
application/scim+json:
schema:
properties:
userName:
description: Unique identifier for the User. Typically used to directly authenticate to the service provider. Each User MUST include a non-empty userName value. This identifier MUST be unique across the entire set of Users. This attribute cannot be changed.
type: string
example: Mock.User
name:
description: 'The components of the User’s real name. Providers may return just the full name as a single string in the formatted sub-attribute, or they MAY return just the individual component attributes using the other sub-attributes, or they MAY return both. If both variants are returned, they SHOULD be describing the same name, with the formatted name indicating how the component attributes should be combined.'
properties:
formatted:
description: 'The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.'
type: string
example: 'Ms. Barbara J Jensen, III'
familyName:
description: 'The family name of the User, or Last Name in most Western languages'
type: string
example: Jensen
givenName:
description: 'The given name of the User, or First Name in most Western languages'
type: string
example: Barbara
displayName:
description: 'The name of the User, suitable for display to end-users. The name should be the full name of the User being described.'
type: string
example: Barbara Jensen
userType:
description: 'The type of the User, identifying the relationship between the organization and the User.'
type: string
example: employee
active:
description: A Boolean value indicating the User’s administrative status.
type: boolean
example: true
password:
description: The User's case-sensitive cleartext password. This attribute is intended to be used as a means to specify an initial password when creating a new User or to reset an existing User's password. This attribute will never be returned in a response.
type: string
emails:
description: 'Email addresses for the user. The value SHOULD be canonicalized by the Service Provider, e.g., bjensen@example.com instead of bjensen@EXAMPLE.COM. Canonical Type values of work, home, and other.'
type: array
items:
properties:
type:
description: 'Type of email address (work, home, other).'
type: string
example: work
value:
description: Canonicalized email address.
type: string
format: email
example: Barbara.Jensen@example.com
primary:
description: A Boolean value indicating the primary e-mail address. The primary attribute value 'true' MUST appear no more than once.
type: boolean
example: 'true'
'urn:ietf:params:scim:schemas:sailpoint:1.0:User':
properties:
capabilities:
description: Capabilities assigned to this User.
type: array
items:
type: string
example: '["SystemAdministrator"]'
administrator:
description: The Administrator of the RPA or Service Account. This attribute is only applicable if the User type is RPA/Bots or Service.
properties:
displayName:
description: The display name of the Administrator of RPA user or Service account.
type: string
example: Bob Smith
value:
description: The id of the SCIM resource representing the Administrator of RPA user or Service account.
type: string
example: c0a7777a7f74744d817e74fc12362c67O
$ref:
description: The URI of the SCIM resource representing the Administrator of RPA user or Service Account.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0a7777a7f74744d817e74fc12362c67'
softwareVersion:
description: The software version of the RPA/Bots.
type: string
example: '7.3'
empId:
description: Employee id associated with this User.
type: string
example: 1b2a3c
dn:
description: Distinguished name for this User.
type: string
example: 'cn=Bob Smith,ou=services'
region:
description: The region this User is assigned to.
type: string
example: Americas
regionOwner:
description: The User who owns the region that this resource (User) belongs to.
properties:
displayName:
description: Display name of the region owner.
type: string
example: Joe Smith
value:
description: The id of the region owner.
type: string
example: c0b4568a4fe7458c434ee77d1fbt156b
$ref:
description: URI reference of the region owner resource.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b'
location:
description: The location this User is assigned to.
type: string
example: Singapore
locationOwner:
description: The User who owns the location that this resource (User) belongs to.
type: object
properties:
displayName:
description: Display name of the location owner.
type: string
example: Bob Smith
value:
description: The id of the location owner.
type: string
example: c0a7778b7ef71e79817ee74e6a1f0444
$ref:
description: URI reference to the location owner resource.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444'
Department:
description: Department this User is assigned to.
type: string
example: Regional Operations
costcenter:
description: Cost centers this User is associated with.
type: array
items:
type: string
example:
- CC01
- DD02
jobtitle:
description: Job title given to this User.
type: string
example: Internal Audit Manager
'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User':
description: Enterprise User Schema. Contains the manager of the User.
properties:
manager:
description: Manager of the user.
properties:
displayName:
description: Display name of the manager.
type: string
example: Bob Smith
value:
description: The id of the manager.
type: string
example: c7a7347a7fe71e69077ee75f5d1f1237
$ref:
description: Reference to the manager resource.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c7a7347a7fe71e69077ee75f5d1f1237'
required:
- userName
'*/*':
schema:
properties:
userName:
description: Unique identifier for the User. Typically used to directly authenticate to the service provider. Each User MUST include a non-empty userName value. This identifier MUST be unique across the entire set of Users. This attribute cannot be changed.
type: string
example: Mock.User
name:
description: 'The components of the User’s real name. Providers may return just the full name as a single string in the formatted sub-attribute, or they MAY return just the individual component attributes using the other sub-attributes, or they MAY return both. If both variants are returned, they SHOULD be describing the same name, with the formatted name indicating how the component attributes should be combined.'
properties:
formatted:
description: 'The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.'
type: string
example: 'Ms. Barbara J Jensen, III'
familyName:
description: 'The family name of the User, or Last Name in most Western languages'
type: string
example: Jensen
givenName:
description: 'The given name of the User, or First Name in most Western languages'
type: string
example: Barbara
displayName:
description: 'The name of the User, suitable for display to end-users. The name should be the full name of the User being described.'
type: string
example: Barbara Jensen
userType:
description: 'The type of the User, identifying the relationship between the organization and the User.'
type: string
example: employee
active:
description: A Boolean value indicating the User’s administrative status.
type: boolean
example: true
password:
description: The User's case-sensitive cleartext password. This attribute is intended to be used as a means to specify an initial password when creating a new User or to reset an existing User's password. This attribute will never be returned in a response.
type: string
emails:
description: 'Email addresses for the user. The value SHOULD be canonicalized by the Service Provider, e.g., bjensen@example.com instead of bjensen@EXAMPLE.COM. Canonical Type values of work, home, and other.'
type: array
items:
properties:
type:
description: 'Type of email address (work, home, other).'
type: string
example: work
value:
description: Canonicalized email address.
type: string
format: email
example: Barbara.Jensen@example.com
primary:
description: A Boolean value indicating the primary e-mail address. The primary attribute value 'true' MUST appear no more than once.
type: boolean
example: 'true'
'urn:ietf:params:scim:schemas:sailpoint:1.0:User':
properties:
capabilities:
description: Capabilities assigned to this User.
type: array
items:
type: string
example: '["SystemAdministrator"]'
administrator:
description: The Administrator of the RPA or Service Account. This attribute is only applicable if the User type is RPA/Bots or Service.
properties:
displayName:
description: The display name of the Administrator of RPA user or Service account.
type: string
example: Bob Smith
value:
description: The id of the SCIM resource representing the Administrator of RPA user or Service account.
type: string
example: c0a7777a7f74744d817e74fc12362c67O
$ref:
description: The URI of the SCIM resource representing the Administrator of RPA user or Service Account.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0a7777a7f74744d817e74fc12362c67'
softwareVersion:
description: The software version of the RPA/Bots.
type: string
example: '7.3'
empId:
description: Employee id associated with this User.
type: string
example: 1b2a3c
dn:
description: Distinguished name for this User.
type: string
example: 'cn=Bob Smith,ou=services'
region:
description: The region this User is assigned to.
type: string
example: Americas
regionOwner:
description: The User who owns the region that this resource (User) belongs to.
properties:
displayName:
description: Display name of the region owner.
type: string
example: Joe Smith
value:
description: The id of the region owner.
type: string
example: c0b4568a4fe7458c434ee77d1fbt156b
$ref:
description: URI reference of the region owner resource.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b'
location:
description: The location this User is assigned to.
type: string
example: Singapore
locationOwner:
description: The User who owns the location that this resource (User) belongs to.
type: object
properties:
displayName:
description: Display name of the location owner.
type: string
example: Bob Smith
value:
description: The id of the location owner.
type: string
example: c0a7778b7ef71e79817ee74e6a1f0444
$ref:
description: URI reference to the location owner resource.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444'
Department:
description: Department this User is assigned to.
type: string
example: Regional Operations
costcenter:
description: Cost centers this User is associated with.
type: array
items:
type: string
example:
- CC01
- DD02
jobtitle:
description: Job title given to this User.
type: string
example: Internal Audit Manager
'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User':
description: Enterprise User Schema. Contains the manager of the User.
properties:
manager:
description: Manager of the user.
properties:
displayName:
description: Display name of the manager.
type: string
example: Bob Smith
value:
description: The id of the manager.
type: string
example: c7a7347a7fe71e69077ee75f5d1f1237
$ref:
description: Reference to the manager resource.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c7a7347a7fe71e69077ee75f5d1f1237'
required:
- userName
responses:
'200':
description: Updates an existing User and returns that User.
content:
application/json:
schema:
properties:
id:
description: IdentityIQ id of the User.
type: string
example: c0b4568a4fe7458c434ee77d1fbt156b
userName:
description: Unique identifier for the User. Typically used to directly authenticate to the service provider. Each User MUST include a non-empty userName value. This identifier MUST be unique across the entire set of Users. Cannot be changed.
type: string
example: Mock.User
name:
description: 'The components of the User’s real name. Providers may return just the full name as a single string in the formatted sub-attribute, or they MAY return just the individual component attributes using the other sub-attributes, or they MAY return both. If both variants are returned, they SHOULD be describing the same name, with the formatted name indicating how the component attributes should be combined.'
properties:
formatted:
description: 'The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.'
type: string
example: 'Ms. Barbara J Jensen, III'
familyName:
description: 'The family name of the User, or Last Name in most Western languages'
type: string
example: Jensen
givenName:
description: 'The given name of the User, or First Name in most Western languages'
type: string
example: Barbara
displayName:
description: 'The name of the User, suitable for display to end-users. The name should be the full name of the User being described.'
type: string
example: Barbara Jensen
userType:
description: 'The type of the User, identifying the relationship between the organization and the User.'
type: string
example: employee
active:
description: A Boolean value indicating the User’s administrative status.
type: boolean
example: true
emails:
description: 'Email addresses for the user. The value SHOULD be canonicalized by the Service Provider, e.g., bjensen@example.com instead of bjensen@EXAMPLE.COM. Canonical Type values of work, home, and other.'
type: array
items:
properties:
type:
description: 'Type of email address (work, home, other).'
type: string
example: work
value:
description: Canonicalized email address.
type: string
format: email
example: Barbara.Jensen@example.com
primary:
description: A Boolean value indicating the primary e-mail address. The primary attribute value 'true' MUST appear no more than once.
type: boolean
example: 'true'
'urn:ietf:params:scim:schemas:sailpoint:1.0:User':
description: Additional attributes of the User.
type: object
properties:
accounts:
description: Simple representation of the Account (or Link) ResourceType.
type: array
items:
properties:
displayName:
description: The display name of the Account.
type: string
example: Bob.Smith
value:
description: The id of the SCIM resource representing the Account.
type: string
example: c0a7778b7ef71e79817ee74e6a1f0444
$ref:
description: The URI of the SCIM resource representing the Account.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Accounts/c0a7778b7ef71e79817ee74e6a1f0444'
entitlements:
description: Entitlements of the User. Returned in response only if requested using the 'attributes' query parameter.
type: array
items:
properties:
value:
description: The value of the Entitlement.
type: string
example: groupmbr
display:
description: The display name of the Entitlement.
type: string
example: HelpDesk
type:
description: 'The type of Entitlement (Entitlement, Permission, etc.).'
type: string
example: Permission
application:
description: The name of the Application this Entitlement applies to.
type: string
example: ADMockApp
accountName:
description: The account this Entitlement was sourced from.
type: string
example: 'CN=Barbara Jensen,OU=Taipei,OU=Asia-Pacific,DC=example,DC=com'
$ref:
description: The URI of the SCIM resource representing the Entitlement.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Entitlements/c0a7777a7f74744d817e74fc12362c67'
roles:
description: Roles of the User. Returned only if requested. Returned in response only if requested using the 'attributes' query parameter.
type: array
items:
properties:
value:
description: The value of the Role.
type: string
example: detectedRoles
display:
description: The display name of the Role.
type: string
example: User - IT
type:
description: 'The type of Role (IT, Business, etc.).'
type: string
example: it
acquired:
description: Indicates how this Role was acquired. Assigned or Detected.
type: string
example: Assigned
application:
description: The name of the Application where this Role came from.
type: string
example: Active_Directory
accountName:
description: The name of the Account this Role was sourced from.
type: string
example: 'CN=Barbara Jensen,OU=Taipei,OU=Asia-Pacific,DC=example,DC=com'
$ref:
description: The URI of the SCIM resource representing the Role.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Roles/c0a7777a7f74744d817e74fc12362c67'
capabilities:
description: Capabilities assigned to this User.
type: array
items:
type: string
example: '["SystemAdministrator"]'
riskScore:
description: Composite Risk Score of this User.
type: integer
example: 125
isManager:
description: A Boolean value that determines if this User is a manager.
type: boolean
example: false
administrator:
description: The Administrator of the RPA or Service Account. This attribute is only applicable if the User type is RPA/Bots or Service.
properties:
displayName:
description: The display name of the Administrator of RPA user or Service account.
type: string
example: Bob Smith
value:
description: The id of the SCIM resource representing the Administrator of RPA user or Service account.
type: string
example: c0a7777a7f74744d817e74fc12362c67O
$ref:
description: The URI of the SCIM resource representing the Administrator of RPA user or Service Account.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0a7777a7f74744d817e74fc12362c67'
softwareVersion:
description: The software version of the RPA/Bots.
type: string
example: '7.3'
empId:
description: Employee id associated with this User.
type: string
example: 1b2a3c
dn:
description: Distinguished name for this User.
type: string
example: 'cn=Bob Smith,ou=services'
region:
description: The region this User is assigned to.
type: string
example: Americas
regionOwner:
description: The User who owns the region that this resource (User) belongs to.
properties:
displayName:
description: Display name of the region owner.
type: string
example: Joe Smith
value:
description: The id of the region owner.
type: string
example: c0b4568a4fe7458c434ee77d1fbt156b
$ref:
description: URI reference of the region owner resource.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b'
location:
description: The location this User is assigned to.
type: string
example: Singapore
locationOwner:
description: The User who owns the location that this resource (User) belongs to.
type: object
properties:
displayName:
description: Display name of the location owner.
type: string
example: Bob Smith
value:
description: The id of the location owner.
type: string
example: c0a7778b7ef71e79817ee74e6a1f0444
$ref:
description: URI reference to the location owner resource.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444'
Department:
description: Department this User is assigned to.
type: string
example: Regional Operations
costcenter:
description: Cost centers this User is associated with.
type: array
items:
type: string
example:
- CC01
- DD02
jobtitle:
description: Job title given to this User.
type: string
example: Internal Audit Manager
lastRefresh:
description: Datetime representation of the last refresh for this User.
type: string
format: date-time
'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User':
description: Enterprise User Schema. Contains the manager of the User.
properties:
manager:
description: Manager of the User.
properties:
displayName:
description: Display name of the User's manager.
type: string
example: Bob Smith
value:
description: The id of the SCIM resource representing the User’s manager.
type: string
example: c7a7347a7fe71e69077ee75f5d1f1237
$ref:
description: The URI of the SCIM resource representing the User’s manager.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c7a7347a7fe71e69077ee75f5d1f1237'
meta:
description: Metadata of the resource.
properties:
created:
description: Datetime this resource was created.
type: string
format: date-time
example: '2022-02-11T01:34:04.074-05:00'
location:
description: The location of the resource.
type: string
example: 'http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b'
lastModified:
description: Datetime the resource was last modified.
type: string
format: date-time
example: '2022-02-11T01:08:45.866-05:00'
version:
description: The version of the resource.
type: string
example: W"1644561244074"
resourceType:
description: The SCIM resource type.
type: string
example: User
schemas:
description: The schemas involved in the SCIM resource.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:schemas:sailpoint:1.0:User'
- 'urn:ietf:params:scim:schemas:core:2.0:User'
- 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User'
delete:
operationId: deleteUser
tags:
- Users
summary: Deletes an existing User.
description: The endpoint used to delete a User resource. **This is not reversible.**
parameters:
- name: userId
in: path
schema:
type: string
example: c7c7777c7ef77e77777ee77e7a1f0444
description: 'The id of User resource. If **lookupByName** is set to **true**, this path parameter should be set to the **userName** of the User.'
required: true
- in: query
name: lookupByName
schema:
type: boolean
example: false
default: false
description: 'A boolean value that determines if the User resource will be looked up by userName instead of userId (value in path parameter ''userId''). Setting this query parameter to true will cause the value pulled from the ''userId'' path parameter to be treated as a userName when searching for the resource.
**Example**: scim/v2/Users/**Mock.User**?**lookupByName=true**'
responses:
'204':
description: Returns a 204 with no response body if delete was successful.
/scim/v2/Workflows:
get:
operationId: WorkflowsGet
tags:
- Workflows
summary: Returns all Workflow resources.
description: |
This endpoint returns all Workflow resources.
Attributes to include in the response can be specified with the 'attributes' query parameter.
Attributes to exclude from the response can be specified with the 'excludedAttributes' query parameter.
The schema related to Workflow is:
- **urn:ietf:params:scim:schemas:sailpoint:1.0:Workflow**
parameters:
- in: query
name: filter
schema:
type: string
example: name eq "Do Provisioning Forms"
description: 'Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported.'
- in: query
name: lookupByName
schema:
type: boolean
default: false
example: true
description: '**(OPTIONAL)** Set to true if the Workflows name is passed instead of the Workflow id.'
- in: query
name: sortBy
schema:
type: string
example: name
description: Allows sorting the results by a resource's attributes.
- in: query
name: sortOrder
schema:
type: string
default: ascending
example: descending
description: Determines what order to sort results in.
- in: query
name: startIndex
schema:
type: integer
example: 15
default: 1
description: Determines the starting index of the result set.
- in: query
name: count
schema:
type: integer
example: 15
default: 1000
description: Specifies the number of results per page.
- in: query
name: attributes
schema:
type: string
example: name
description: 'A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.'
- in: query
name: excludedAttributes
schema:
type: string
example: 'name, type'
description: A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**
responses:
'200':
description: Returned all SCIM resources for this endpoint.
content:
application/json:
schema:
properties:
totalResults:
description: Number of resources returned for this endpoint.
type: integer
example: '1,'
startIndex:
description: The starting index of the resource set list. Can be specified with startIndex query parameter.
type: integer
example: 1
schemas:
description: SCIM Schema used for response.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:api:messages:2.0:ListResponse'
Resources:
type: array
items:
required:
- name
properties:
id:
description: Unique identifier of the Workflow.
type: string
example: 7f00000180281df7818028bf977502f3
name:
description: Name of the Workflow.
type: string
example: Identity Request Approve Identity Changes
description:
description: Description of the Workflow.
type: string
example: |2
The subprocess that drives the Create and Update Identity workflows.
This is different then the Identity Request Approve subprocess because this
approval process produces a form with the approval so that
approvers can update values while approving.
This subprocess builds the form necessary for the editable approvals
and then assimilates that data entered back to the plan, which
can be returned from the subprocess.
type:
description: Type of the Workflow.
type: string
enum:
- Batch Provisioning
- Scheduled Assignment
- Scheduled Role Activation
- Managed Attribute
- Identity Correlation
- Identity Event
- Identity Lifecycle
- Identity Update
- Identity Refresh
- LCM Identity
- LCM Provisioning
- LCM Registration
- Policy Violation
- Role Modeler
- Subprocess
- Password Intercept
- Alert
- Attribute Sync
example: Subprocess
handler:
description: Handler of the Workflow.
type: string
example: sailpoint.api.StandardWorkflowHandler
meta:
type: object
properties:
created:
description: DateTime when the Workflow was created.
type: string
example: '2022-04-14T10:44:46.453-05:00'
location:
description: URL to the Workflow.
type: string
example: 'http://localhost:8080/identityiq/scim/v2/Workflows/7f00000180281df7818028bf977502f3'
lastModified:
description: DateTime of Workflow last modification.
type: string
example: '2022-05-05T15:52:30.119-05:00'
version:
description: Workflow version.
type: string
example: W"1649951086453"
resourceType:
description: Resource type of the metadata subject.
type: string
example: Workflow
application/scim+json:
schema:
properties:
totalResults:
description: Number of Workflow resources returned.
type: integer
example: '1500,'
startIndex:
description: The starting index of the resource set list. Can be specified with startIndex query parameter.
type: integer
example: 1
schemas:
description: SCIM Schema used for response.
type: array
items:
type: string
example:
- 'urn:ietf:params:scim:api:messages:2.0:ListResponse'
Resources:
description: The SCIM resources returned for this endpoint.
type: array
items:
required:
- name
properties:
id:
description: Unique identifier of the Workflow.
type: string
example: 7f00000180281df7818028bf977502f3
name:
description: Name of the Workflow.
type: string
example: Identity Request Approve Identity Changes
description:
description: Description of the Workflow.
type: string
example: |2
The subprocess that drives the Create and Update Identity workflows.
This is different then the Identity Request Approve subprocess because this
approval process produces a form with the approval so that
approvers can update values while approving.
This subprocess builds the form necessary for the editable approvals
and then assimilates that data entered back to the plan, which
can be returned from the subprocess.
type:
description: Type of the Workflow.
type: string
enum:
- Batch Provisioning
- Scheduled Assignment
- Scheduled Role Activation
- Managed Attribute
- Identity Correlation
- Identity Event
- Identity Lifecycle
- Identity Update
- Identity Refresh
- LCM Identity
- LCM Provisioning
- LCM Registration
- Policy Violation
- Role Modeler
- Subprocess
- Password Intercept
- Alert
- Attribute Sync
example: Subprocess
handler:
description: Handler of the Workflow.
type: string
example: sailpoint.api.StandardWorkflowHandler
meta:
type: object
properties:
created:
description: DateTime when the Workflow was created.
type: string
example: '2022-04-14T10:44:46.453-05:00'
location:
description: URL to the Workflow.
type: string
example: 'http://localhost:8080/identityiq/scim/v2/Workflows/7f00000180281df7818028bf977502f3'
lastModified:
description: DateTime of Workflow last modification.
type: string
example: '2022-05-05T15:52:30.119-05:00'
version:
description: Workflow version.
type: string
example: W"1649951086453"
resourceType:
description: Resource type of the metadata subject.
type: string
example: Workflow
'/scim/v2/Workflows/{workflowId}':
get:
operationId: getWorkflowById
tags:
- Workflows
summary: Returns a Workflow resource based on id.
description: |
The Workflow resource with matching id is returned.
Attributes to include in the response can be specified with the attributes query parameter.
Attributes to exclude from the response can be specified with the excludedAttributes query parameter.
The schema related to Workflow is:
- **urn:ietf:params:scim:schemas:sailpoint:1.0:Workflow**
parameters:
- name: workflowId
in: path
schema:
type: string
example: c0a8019c802d1e5a81802eb2b57e020f
description: id of Workflow resource.
required: true
- in: query
name: attributes
schema:
type: string
example: 'name, type'
description: 'A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.'
- in: query
name: excludedAttributes
schema:
type: string
example: 'name, handler'
description: A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**
responses:
'200':
description: Returns a single Workflow resource based on the id.
content:
application/json:
schema:
required:
- name
properties:
id:
description: Unique identifier of the Workflow.
type: string
example: 7f00000180281df7818028be6a9c01a3
name:
description: Name of the Workflow.
type: string
example: Aggregate Correlated Applications
description:
description: Description of the Workflow.
type: string
example: Library for Steps.
type:
type: string
description: Type of the Workflow.
enum:
- Batch Provisioning
- Scheduled Assignment
- Scheduled Role Activation
- Managed Attribute
- Identity Correlation
- Identity Event
- Identity Lifecycle
- Identity Update
- Identity Refresh
- LCM Identity
- LCM Provisioning
- LCM Registration
- Policy Violation
- Role Modeler
- Subprocess
- Password Intercept
- Alert
- Attribute Sync
example: Step Library
handler:
description: Handler of the Workflow.
type: string
example: sailpoint.api.StandardWorkflowHandler
meta:
type: object
properties:
created:
description: DateTime when the Workflow was created.
type: string
format: date-time
example: '2022-04-14T10:43:29.436-05:00'
location:
description: URL to the Workflow.
type: string
example: 'http://localhost:8080/identityiq/scim/v2/Workflows/7f00000180281df7818028be6a9c01a3'
lastModified:
description: DateTime of Workflow last modification.
type: string
format: date-time
example: '2022-05-05T15:52:30.119-05:00'
version:
description: Workflow version.
type: string
example: '"W"1649951094834"'
resourceType:
description: Resource type of the metadata subject.
type: string
example: Workflow
/rest:
get:
operationId: core_CertificationRevocationResource_getCompletedRevocations
tags:
- Certifications
summary: Return the revoked items for this certification
description: Return the revoked items for this certification
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
put:
operationId: core_DynamicScopeResource_updateDynamicScope
tags:
- Dynamic Scopes
summary: Updates the specified DynamicScope object with passed in data map
description: Updates the specified DynamicScope object with passed in data map
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"ds": {}, "name": "Example Item", "description": "A brief description.", "populationRequestControlMap": {"key": "value"}, "inclusions": ["example-value"], "exclusions": ["example-value"], "roleRequestControlId": "abc-12345", "roleRequestControlName": "Example Rolerequestcontrol", "applicationRequestControlId": "abc-12345", "applicationRequestControlName": "Example Applicationrequestcontrol", "managedAttributeRequestControlId": "abc-12345", "managedAttributeRequestControlName": "Example Managedattributerequestcontrol", "roleRemoveControlId": "abc-12345", "roleRemoveControlName": "Example Roleremovecontrol", "applicationRemoveControlId": "abc-12345", "applicationRemoveControlName": "Example Applicationremovecontrol", "managedAttributeRemoveControlId": "abc-12345", "managedAttributeRemoveControlName": "Example Managedattributeremovecontrol", "quickLinkOptionsList": [{}], "clazz": {}, "definitionType": "ExampleType", "popAuthority": {}, "matchConfig": {}, "jsonData": "example-jsonData", "id": "abc-12345", "popRequest": {}, "attributeControlFilter": "example-attributeControlFilter", "attributeFilterControl": {}, "filterGenerationRuleName": "Example Filtergenerationrule", "iList": [{}], "exculsionList": [{}], "inculsionList": [{}], "identityList": [{}], "retList": [{}], "rule": {}, "map": {"key": "value"}, "selector": {}, "qlo": {}, "mapper": {}, "root": {}, "filterClass": {}}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"ds": {}, "name": "Example Item", "description": "A brief description.", "populationRequestControlMap": {"key": "value"}, "inclusions": ["example-value"], "exclusions": ["example-value"], "roleRequestControlId": "abc-12345", "roleRequestControlName": "Example Rolerequestcontrol", "applicationRequestControlId": "abc-12345", "applicationRequestControlName": "Example Applicationrequestcontrol", "managedAttributeRequestControlId": "abc-12345", "managedAttributeRequestControlName": "Example Managedattributerequestcontrol", "roleRemoveControlId": "abc-12345", "roleRemoveControlName": "Example Roleremovecontrol", "applicationRemoveControlId": "abc-12345", "applicationRemoveControlName": "Example Applicationremovecontrol", "managedAttributeRemoveControlId": "abc-12345", "managedAttributeRemoveControlName": "Example Managedattributeremovecontrol", "quickLinkOptionsList": [{}], "clazz": {}, "definitionType": "ExampleType", "popAuthority": {}, "matchConfig": {}, "jsonData": "example-jsonData", "id": "abc-12345", "popRequest": {}, "attributeControlFilter": "example-attributeControlFilter", "attributeFilterControl": {}, "filterGenerationRuleName": "Example Filtergenerationrule", "iList": [{}], "exculsionList": [{}], "inculsionList": [{}], "identityList": [{}], "retList": [{}], "rule": {}, "map": {"key": "value"}, "selector": {}, "qlo": {}, "mapper": {}, "root": {}, "filterClass": {}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
delete:
operationId: core_DynamicScopeResource_deleteDynamicScope
tags:
- Dynamic Scopes
summary: Removes the specified dynamic scope object
description: Removes the specified dynamic scope object
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: core_IdentityResource_createIdentity
tags:
- Identities
summary: Create a new identity with the attributes in the given map
description: Create a new identity with the attributes in the given map
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"application": "Example Application", "colKey": "example-colKey", "nativeIdentity": "abc-12345", "roleId": "abc-12345", "showNonMatched": "example-showNonMatched", "teamsUserId": "abc-12345"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"application": "Example Application", "colKey": "example-colKey", "nativeIdentity": "abc-12345", "roleId": "abc-12345", "showNonMatched": "example-showNonMatched", "teamsUserId": "abc-12345"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/accountGroupHierarchy/childNode:
post:
operationId: core_AccountGroupHierarchyResource_getChildNode
tags:
- Account Groups
summary: Get child node
description: Get child node
requestBody:
content:
application/json:
schema:
type: object
description: MultivaluedMap
example: {"children": "example-children", "id": "abc-12345", "leaf": "example-leaf", "name": "Example Name", "node": "example-node", "text": "example-text"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"children": "example-children", "id": "abc-12345", "leaf": "example-leaf", "name": "Example Name", "node": "example-node", "text": "example-text"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/accountGroupHierarchy/initialNode:
post:
operationId: core_AccountGroupHierarchyResource_getInitialNode
tags:
- Account Groups
summary: Get initial node
description: Get initial node
requestBody:
content:
application/json:
schema:
type: object
description: MultivaluedMap
example: {"children": "example-children", "id": "abc-12345", "leaf": "example-leaf", "name": "Example Name", "node": "example-node", "text": "example-text"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"children": "example-children", "id": "abc-12345", "leaf": "example-leaf", "name": "Example Name", "node": "example-node", "text": "example-text"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/aggregate:
post:
operationId: core_IdentityResource_aggregate
tags:
- Identities
summary: Aggregate the given resource object for the given application onto the given identity
description: Aggregate the given resource object for the given application onto the given identity
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"application": "Example Application", "colKey": "example-colKey", "nativeIdentity": "abc-12345", "roleId": "abc-12345", "showNonMatched": "example-showNonMatched", "teamsUserId": "abc-12345"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"application": "Example Application", "colKey": "example-colKey", "nativeIdentity": "abc-12345", "roleId": "abc-12345", "showNonMatched": "example-showNonMatched", "teamsUserId": "abc-12345"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/alertDefinitions:
get:
operationId: core_AlertDefinitionListResource_getAlertDefinitions
tags:
- Alerts
summary: Get alert definitions
description: Get alert definitions
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: core_AlertDefinitionListResource_create
tags:
- Alerts
summary: Create
description: Create
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"limit": 25, "start": 0}
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/alertDefinitions/suggest/suggest/column/{class}/{column}':
post:
operationId: core_SuggestResource_getDistinctColumnSuggest
tags:
- Suggest
summary: Get distinct column suggest
description: Get distinct column suggest
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
- in: path
name: column
required: true
description: The column.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/alertDefinitions/suggest/suggest/object/{class}':
post:
operationId: core_SuggestResource_getSuggest
tags:
- Suggest
summary: Returns a json data feed for a suggest component for the given class type
description: Returns a json data feed for a suggest component for the given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
get:
operationId: core_SuggestResource_simpleList
tags:
- Suggest
summary: Simple list
description: Simple list
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/alertDefinitions/suggest/suggest/uiconfig:
post:
operationId: core_SuggestResource_getUIConfigSuggest
tags:
- Suggest
summary: Get ui config suggest
description: Get ui config suggest
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/alertDefinitions/{alertDefId}':
get:
operationId: core_AlertDefinitionResource_getAlertDefinition
tags:
- Alerts
summary: Get alert definition
description: Get alert definition
parameters:
- in: path
name: alertDefId
required: true
description: The alertDefId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: AlertDefinitionDTO
example: {"name": "Example Item", "displayName": "Example Display", "description": "A brief description.", "owner": {"name": "Example Item", "firstName": "Example First", "lastName": "Example Last", "displayName": "Example Display", "workgroup": true, "pseudo": true, "locked": true}, "created": "2024-01-01T00:00:00Z", "actionConfig": {}, "matchConfig": {}, "dto": {}, "ident": {"objectConfig": {}, "systemAttributes": {"key": "value"}, "links": [{}], "detectedRoles": [{}], "assignedRoles": [{}], "roleMetadatas": [{}], "exceptions": [{}], "mitigationExpirations": [{}], "preferences": {"key": "value"}, "manager": {}, "capabilities": [{}], "controlledScopes": [{}], "controlsAssignedScope": true, "password": "**hidden**", "scorecard": {}, "lastLogin": "example-lastLogin", "lastRefresh": "example-lastRefresh", "activityConfig": {}, "capabilityManager": {}, "authApplication": {}, "authAccount": {}, "identityEntitlements": [{}], "correlatedOverridden": true, "flattenedRights": {}, "effectiveRights": {}, "bundleSummary": "example-bundleSummary", "assignedRoleSummary": "example-assignedRoleSummary", "attributes": {"key": "value"}, "uiPreferences": {}, "passwordExpiration": "example-passwordExpiration", "passwordHistory": "example-passwordHistory", "authenticationAnswers": [{}], "authLockStart": "example-authLockStart", "certifications": [{}], "workgroups": [{}], "administrator": {}, "extendedIdentity1": {}, "extendedIdentity2": {}, "extendedIdentity3": {}, "extendedIdentity4": {}, "extendedIdentity5": {}, "config": {}, "value": "example-value", "name": "Example Item", "key": "example-key", "buildList": [{}], "def": {}, "sources": [{}], "metadata": {}, "displayName": "Example Display", "custom": {"key": "value"}, "keys": ["example-value"], "atts": {"key": "value"}, "attributeDefinition": {}, "result": {}, "attr": "example-attr", "found": [{}], "linkInstance": "example-linkInstance", "displayNameFound": {}, "uuidFound": {}, "uuid": "abc-12345", "id": "abc-12345", "appname": "Example App", "identity": "example-identity", "composite": {}, "composites": [{}], "collection": {}, "attrs": {"key": "value"}, "es": {}, "assignedAndDetectedRoles": [{}], "inheritance": [{}], "requirements": [{}], "summary": "example-summary", "buf": {}, "bundles": [{}], "existingMetadata": {}, "appId": "abc-12345", "it": {}, "l": {}, "link": {}, "d": "example-d", "last": "example-last", "certLinks": {}, "svc": {}, "historyItem": {}, "snapshots": {"key": "value"}, "caps": [{}], "directRights": ["example-value"], "indirectRights": ["example-value"], "effective": [{}], "localCaps": [{}], "indirect": [{}], "capNames": ["example-value"], "scopes": [{}], "groups": [{}], "wgScopes": [{}], "scopeIt": {}, "distinctScopes": [{}], "scope": {}, "childScopes": [{}], "scopeNames": ["example-value"], "val": "example-val", "current": [{}], "ass": {}, "assignments": [{}], "o": "example-o", "assign": {}, "as": {}, "roles": [{}], "list": [{}], "negativeAssignments": [{}], "active": [{}], "foundAssignments": [{}], "match": {}, "assignment": {}, "requests": [{}], "appRoleDetects": [{}], "filteredDetections": [{}], "detections": [{}], "det": {}, "otherId": "abc-12345", "unassignedDetection": {}, "mappings": {"key": "value"}, "role": {}, "ents": [{}], "comparator": {}, "appCerts": {"key": "value"}, "conflictingCert": {}, "certLinkArray": [{}], "triggers": {"key": "value"}, "standardAttributeNames": ["example-value"], "type": {}}, "actionType": {"displayName": "Example Display", "name": "Example Item"}, "workflow": {"displayName": "Example Display", "name": "Example Item"}, "certificationTrigger": {"displayName": "Example Display", "name": "Example Item"}, "emailTemplate": {"displayName": "Example Display", "name": "Example Item"}, "emailRecipients": [{"name": "Example Item", "firstName": "Example First", "lastName": "Example Last", "displayName": "Example Display", "workgroup": true, "pseudo": true, "locked": true}], "dtos": [{"name": "Example Item", "firstName": "Example First", "lastName": "Example Last", "displayName": "Example Display", "workgroup": true, "pseudo": true, "locked": true}], "d": {"name": "Example Item", "firstName": "Example First", "lastName": "Example Last", "displayName": "Example Display", "workgroup": true, "pseudo": true, "locked": true}, "t": {"owner": {}, "classifications": [{}], "uid": "abc-12345", "id": "abc-12345", "name": "Example Item", "lock": "example-lock", "description": "A brief description.", "created": "2024-01-01T00:00:00Z", "modified": "2024-01-01T00:00:00Z", "significantModified": "example-significantModified", "priorSignificantModified": "example-priorSignificantModified", "allowSignificantModifiedUpdate": true, "assignedScope": {}, "assignedScopePath": "/path/to/resource", "pendingWorkflow": {}, "attributeMetaData": [{}], "interceptedDeletes": [{}], "lockInfo": {}, "action": "example-action", "dirtyPropertyNames": ["example-value"], "path": "/path/to/resource", "value": "example-value", "extended": {"key": "value"}, "config": {}, "att": {}, "atts": {"key": "value"}, "o": "example-o", "date": "2024-01-01T00:00:00Z", "found": {}, "meta": {}, "so": {}, "refs": [{}], "cols": {"key": "value"}, "f": {}, "spo": {}, "collator": {}}, "rule": {"displayName": "Example Display", "name": "Example Item"}, "matchExpression": {}, "matchTerms": [{}], "source": "example-source", "value": "example-value", "children": [{}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
put:
operationId: core_AlertDefinitionResource_updateAlertDefinition
tags:
- Alerts
summary: Update alert definition
description: Update alert definition
parameters:
- in: path
name: alertDefId
required: true
description: The alertDefId path parameter.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"name": "Example Item", "displayName": "Example Display", "description": "A brief description.", "owner": {}, "created": "2024-01-01T00:00:00Z", "actionConfig": {}, "matchConfig": {}, "dto": {}, "ident": {}, "actionType": {}, "workflow": {}, "certificationTrigger": {}, "emailTemplate": {}, "emailRecipients": [{}], "dtos": [{}], "d": {}, "t": {}, "rule": {}, "matchExpression": {}, "matchTerms": [{}], "source": "example-source", "value": "example-value", "children": [{}]}
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
delete:
operationId: core_AlertDefinitionResource_delete
tags:
- Alerts
summary: Delete
description: Delete
parameters:
- in: path
name: alertDefId
required: true
description: The alertDefId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/alerts:
get:
operationId: core_AlertListResource_getAlerts
tags:
- Alerts
summary: Get alerts
description: Get alerts
parameters:
- in: query
name: name
required: false
description: The name query parameter.
schema:
type: string
- in: query
name: source
required: false
description: The source query parameter.
schema:
type: string
- in: query
name: nativeId
required: false
description: The nativeId query parameter.
schema:
type: string
- in: query
name: type
required: false
description: The type query parameter.
schema:
type: string
- in: query
name: targetType
required: false
description: The targetType query parameter.
schema:
type: string
- in: query
name: targetDisplayName
required: false
description: The targetDisplayName query parameter.
schema:
type: string
- in: query
name: alertDateStart
required: false
description: The alertDateStart query parameter.
schema:
type: string
- in: query
name: alertDateEnd
required: false
description: The alertDateEnd query parameter.
schema:
type: string
- in: query
name: lastProcessedStart
required: false
description: The lastProcessedStart query parameter.
schema:
type: string
- in: query
name: lastProcessedEnd
required: false
description: The lastProcessedEnd query parameter.
schema:
type: string
- in: query
name: actions
required: false
description: The actions query parameter.
schema:
type: boolean
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/alerts/filters:
get:
operationId: core_AlertListResource_getAlertFilters
tags:
- Alerts
summary: Get alert filters
description: Get alert filters
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: array
items:
type: object
example: [{"id": "12345", "name": "Example Item", "description": "Sample record"}]
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/alerts/suggest/suggest/column/{class}/{column}':
post:
operationId: core_SuggestResource_getDistinctColumnSuggest_2
tags:
- Suggest
summary: Get distinct column suggest
description: Get distinct column suggest
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
- in: path
name: column
required: true
description: The column.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/alerts/suggest/suggest/object/{class}':
post:
operationId: core_SuggestResource_getSuggest_2
tags:
- Suggest
summary: Returns a json data feed for a suggest component for the given class type
description: Returns a json data feed for a suggest component for the given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
get:
operationId: core_SuggestResource_simpleList_2
tags:
- Suggest
summary: Simple list
description: Simple list
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/alerts/suggest/suggest/uiconfig:
post:
operationId: core_SuggestResource_getUIConfigSuggest_2
tags:
- Suggest
summary: Get ui config suggest
description: Get ui config suggest
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/alerts/{alertId}':
get:
operationId: core_AlertResource_getAlert
tags:
- Alerts
summary: Get alert
description: Get alert
parameters:
- in: path
name: alertId
required: true
description: The alertId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: AlertDTO
example: {"name": "Example Item", "displayName": "Example Display", "targetId": "abc-12345", "targetType": "ExampleType", "targetDisplayName": "Example Targetdisplay", "source": "example-source", "type": "ExampleType", "alertDate": "2024-01-01T00:00:00Z", "created": "2024-01-01T00:00:00Z", "nativeId": "abc-12345", "lastProcessed": "example-lastProcessed", "alertAttributes": [{"name": "Example Item", "displayName": "Example Display", "value": "example-value", "description": "A brief description."}], "actions": [{"actionType": "ExampleType", "actionTypeDisplay": "example-actionTypeDisplay", "resultId": "abc-12345", "created": "2024-01-01T00:00:00Z", "definitionName": "Example Definition", "result": {}, "cert": {}, "dto": {}}], "dtos": [{"name": "Example Item", "displayName": "Example Display", "value": "example-value", "description": "A brief description."}], "app": {"text": "Example message text", "objectConfig": {}, "proxy": {}, "connector": "example-connector", "type": "ExampleType", "icon": "example-icon", "config": {"key": "value"}, "features": [{}], "schemas": [{}], "authenticationResource": true, "dataSources": [{}], "targetSource": {}, "targetSources": [{}], "remediators": [{}], "secondaryOwners": {}, "dependencies": [{}], "scorecard": {}, "listeners": [{}], "settings": "example-settings", "list": [{}], "proxiedName": "Example Proxied", "correlationRule": {}, "creationRule": {}, "managerCorrelationRule": {}, "customizationRule": {}, "managedAttributeCustomizationRule": {}, "profileClass": "sailpoint.object.Identity", "accountCorrelationConfig": {}, "provisioningPlan": {}, "provisioningForms": [{}], "passwordPolicies": [{}], "provisioningConfig": {}, "cluster": "example-cluster", "f": {}, "nameList": ["example-value"], "names": {"key": "value"}, "attributes": [{}], "displayableName": "Example Displayable", "types": "example-types", "typeNames": ["example-value"], "aggType": "ExampleType", "r": {}, "s": {}, "found": {}, "forms": [{}], "form": {}, "schema": {}, "exp": "example-exp", "now": "example-now", "lvl": {}, "name": "Example Item", "atts": [{}], "groupSchemas": [{}], "groupSchemaNames": ["example-value"], "objType": "ExampleType", "accntSchema": {}, "ad": {}, "gschemas": [{}], "groupAttrs": [{}], "groupAttr": {}, "dataSource": {}, "srcName": "Example Src", "srcId": "abc-12345", "sources": [{}], "filter": {}, "filterList": [{}], "updatedDataSources": [{}], "updatedRemediators": [{}], "copy": {}, "derived": [{}], "newObj": {}, "obj": "example-obj", "passPolicy": {}, "attname": "Example Att", "gschema": {}, "encrypted": ["example-value"], "encryptedConfig": "example-encryptedConfig", "map": {"key": "value"}, "o": "example-o", "filtered": {}, "xf": {}, "appAttributes": {"key": "value"}, "encryptedAttrValue": "example-encryptedAttrValue", "options": {"key": "value"}, "key": "example-key", "value": "example-value", "notRequestableEntsLvl": {}, "valueObject": "example-valueObject"}, "schema": {"objectType": "ExampleType", "aggregationType": "ExampleType", "nativeObjectType": "ExampleType", "identityAttribute": "example-identityAttribute", "displayAttribute": "example-displayAttribute", "instanceAttribute": "example-instanceAttribute", "groupAttribute": "example-groupAttribute", "hierarchyAttribute": "example-hierarchyAttribute", "descriptionAttribute": "example-descriptionAttribute", "childHierarchy": true, "referenceAttribute": "example-referenceAttribute", "attributes": [{}], "includePermissions": true, "indexPermissions": true, "noPermissionPromotion": true, "permissionsRemediationModificationType": {}, "config": {"key": "value"}, "associationSchemaName": "Example Associationschema", "creationRule": {}, "refreshRule": {}, "correlationRule": {}, "customizationRule": {}, "cloudAccessType": {}, "nameMap": {"key": "value"}, "internalMap": {"key": "value"}, "sourceMap": {"key": "value"}, "attrNamesSet": {}, "groupAtts": ["example-value"], "groupAtt": "example-groupAtt", "name": "Example Item", "internal": "example-internal", "found": {}, "map": {"key": "value"}, "attr": {}, "nameList": ["example-value"], "attrName": "Example Attr", "names": ["example-value"], "defList": [{}], "key": "example-key", "type": "ExampleType", "def": {}, "value": "example-value", "description": "A brief description.", "curKeys": [{}], "toKey": [{}], "att": {}, "list": ["example-value"], "f": {}, "features": "example-features", "schema": {}}, "config": {"HistoricalIdentityCapture": "example-HistoricalIdentityCapture", "HistoricalRoleCapture": "example-HistoricalRoleCapture", "caches": {"key": "value"}, "attributeDefinitions": [{}], "configAttributes": {"key": "value"}, "roleTypes": [{}], "identityTypes": [{}], "defaultIdentityType": {}, "config": {}, "name": "Example Item", "cls": {}, "cname": "Example C", "ahCname": "Example Ahc", "ref": {}, "realClass": {}, "map": {"key": "value"}, "atts": [{}], "list": [{}], "defaultAttributes": {"key": "value"}, "typesMap": {"key": "value"}, "o": "example-o", "types": {"key": "value"}, "current": {}, "dname": "Example D", "att": {}, "attr": {}, "toMatch": {}, "matched": {}, "objectAttributes": [{}], "sourceName": "Example Source", "found": {}}, "atts": {"key": "value"}, "dto": {"name": "Example Item", "displayName": "Example Display", "value": "example-value", "description": "A brief description."}, "description": "A brief description.", "objAtt": {"locale": {}, "rule": {}, "jsonPath": "/path/to/resource", "sources": [{}], "targets": [{}], "identitySelector": {}, "editMode": {}, "listenerRule": {}, "listenerWorkflow": {}, "name": "Example Item", "match": {}, "collator": {}, "source": {}, "mappedTo": "example-mappedTo", "sourceApp": {}, "src": {}, "key": "example-key"}, "attDef": {"messageKey": "example-messageKey", "entitlement": true, "minable": true, "group": true, "managed": true, "remediationModificationType": {}, "source": "example-source", "value": "example-value", "valueMap": {"key": "value"}, "internalName": "Example Internal", "schemaObjectType": "ExampleType", "objectMapping": "example-objectMapping", "componentTokens": ["example-value"], "tokens": ["example-value"], "builder": {}, "token": "example-token", "appName": "Example App", "attrNameBuilder": {}, "ret": "example-ret", "m": {}}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/analyze/{analyzeTabPanel}/suggest/suggest/column/{class}/{column}':
post:
operationId: core_SuggestResource_getDistinctColumnSuggest_3
tags:
- Analysis
summary: Get distinct column suggest
description: Get distinct column suggest
parameters:
- in: path
name: analyzeTabPanel
required: true
description: The analyzeTabPanel path parameter.
schema:
type: string
- in: path
name: class
required: true
description: The class.
schema:
type: string
- in: path
name: column
required: true
description: The column.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/analyze/{analyzeTabPanel}/suggest/suggest/object/{class}':
post:
operationId: core_SuggestResource_getSuggest_3
tags:
- Analysis
summary: Returns a json data feed for a suggest component for the given class type
description: Returns a json data feed for a suggest component for the given class type
parameters:
- in: path
name: analyzeTabPanel
required: true
description: The analyzeTabPanel path parameter.
schema:
type: string
- in: path
name: class
required: true
description: The class.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
get:
operationId: core_SuggestResource_simpleList_3
tags:
- Analysis
summary: Simple list
description: Simple list
parameters:
- in: path
name: analyzeTabPanel
required: true
description: The analyzeTabPanel path parameter.
schema:
type: string
- in: path
name: class
required: true
description: The class.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/analyze/{analyzeTabPanel}/suggest/suggest/uiconfig':
post:
operationId: core_SuggestResource_getUIConfigSuggest_3
tags:
- Analysis
summary: Get ui config suggest
description: Get ui config suggest
parameters:
- in: path
name: analyzeTabPanel
required: true
description: The analyzeTabPanel path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/applications:
get:
operationId: core_ApplicationsResource_getNewApplicationData
tags:
- Applications
summary: This endpoint returns ApplicationModelDTO data for new application in add / edit application flow
description: This endpoint returns ApplicationModelDTO data for new application in add / edit application flow
parameters:
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: ApplicationModelDTO
example: {"details": {"appId": "abc-12345", "name": "Example Item", "revoker": {}, "owner": {}, "proxyApplication": "Example Application", "applicationType": "ExampleType", "profileClass": "sailpoint.object.Identity", "descriptions": {"key": "value"}, "scope": {}, "authoritativeApplication": true, "caseInsensitive": true, "maintenanceEnabled": true, "maintenanceExpiration": 0, "extendedAttributes": {}}, "configuration": {"schemas": {}, "provisioningPolicies": {}}, "correlation": {"accountCorrelationConfig": "example-accountCorrelationConfig", "correlationId": "abc-12345", "existingCorrelationConfigs": [{}], "attributeBasedCorrelations": [{}], "conditionBasedCorrelations": [{}], "managerCorrelationFilter": {}}, "scoreCard": {"scoreItem": {}, "typeName": "Example Type", "targetMsg": {}, "index": {}, "scores": [{}], "scoreItems": [{}], "i": [{}], "used": {}, "parent": "example-parent", "raw": {}, "categoryDisplayName": "Example Categorydisplay", "category": "example-category", "scoreColorMap": {"key": "value"}, "compensatedScoreColorMap": {"key": "value"}, "params": [{}], "displayableNames": ["example-value"], "msg": "example-msg"}, "activityDataSources": {"activityDataSourceList": [{}]}, "unstructuredTargets": {"unstructuredTargetList": [{}]}, "rules": {"aggregationRules": [{}], "provisioningRules": [{}], "schemaRules": {"key": "value"}}, "passwordPolicy": {"passwordPolicyList": [{}], "passwordPolicyExist": true}, "preferences": {"enableLocalizeApplicationDescriptions": true, "locale": {}, "resolvedApplicationType": "ExampleType"}, "attributes": {"key": "value"}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/applications/authoritativeApps:
get:
operationId: core_ApplicationsResource_getAuthoritativeApps
tags:
- Applications
summary: API to check to see if there is at least one authoritative application marked authoritative
description: API to check to see if there is at least one authoritative application marked authoritative
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/applications/configuration/schema/discoverSchemaAttributes:
post:
operationId: core_ApplicationsResource_getSchemaAttributesDiscovered
tags:
- Applications
summary: This endpoint discovers schema attributes when use clicks on Discover Schema Attributes button on Schema tab under configuration tab in add / edit application flow
description: This endpoint discovers schema attributes when use clicks on Discover Schema Attributes button on Schema tab under configuration tab in add / edit application flow
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"appId": "abc-12345", "appType": "Identity", "objectType": "Identity"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: SchemaDTO
example: {"id": "abc-12345", "objectType": "ExampleType", "aggregationType": "ExampleType", "nativeObjectType": "ExampleType", "displayAttribute": "example-displayAttribute", "identityAttribute": "example-identityAttribute", "groupAttribute": "example-groupAttribute", "hierarchyAttribute": "example-hierarchyAttribute", "associationSchemaName": "Example Associationschema", "instanceAttribute": "example-instanceAttribute", "descriptionAttribute": "example-descriptionAttribute", "includePermissions": true, "indexPermissions": true, "childHierarchy": true, "attributes": [{"internalName": "Example Internal", "source": "example-source", "entitlement": true, "schemaObjectType": "ExampleType", "managed": true, "group": true, "minable": true, "indexed": true, "correlationKeyAssigned": true, "objectMapping": "example-objectMapping", "name": "Example Item", "type": "ExampleType", "defaultValue": "example-defaultValue", "description": "A brief description.", "required": true, "multi": true, "compositeSourceAttribute": "example-compositeSourceAttribute", "compositeSourceApplication": "Example Application"}], "config": {"key": "value"}, "features": ["example-value"], "propertyAttributes": ["example-value"], "csvAttributesMap": {"key": "value"}, "provisioningEnabled": true, "aggregationEnabled": true, "needsAggregationType": true, "creationRule": "example-creationRule", "customizationRule": "example-customizationRule", "correlationRule": "example-correlationRule", "refreshRule": "example-refreshRule", "supportsDisable": true, "disableFilterValue": "example-disableFilterValue", "supportsLock": true, "lockFilterValue": "example-lockFilterValue"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/applications/configurations/schema:
get:
operationId: core_ApplicationsResource_getSchemaByAppNameAndObjectType
tags:
- Applications
summary: Retrieves the schema for a given application
description: Retrieves the schema for a given application
parameters:
- in: query
name: appName
required: false
description: The appName query parameter.
schema:
type: string
- in: query
name: objectType
required: false
description: The objectType query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: SchemaDTO
example: {"id": "abc-12345", "objectType": "ExampleType", "aggregationType": "ExampleType", "nativeObjectType": "ExampleType", "displayAttribute": "example-displayAttribute", "identityAttribute": "example-identityAttribute", "groupAttribute": "example-groupAttribute", "hierarchyAttribute": "example-hierarchyAttribute", "associationSchemaName": "Example Associationschema", "instanceAttribute": "example-instanceAttribute", "descriptionAttribute": "example-descriptionAttribute", "includePermissions": true, "indexPermissions": true, "childHierarchy": true, "attributes": [{"internalName": "Example Internal", "source": "example-source", "entitlement": true, "schemaObjectType": "ExampleType", "managed": true, "group": true, "minable": true, "indexed": true, "correlationKeyAssigned": true, "objectMapping": "example-objectMapping", "name": "Example Item", "type": "ExampleType", "defaultValue": "example-defaultValue", "description": "A brief description.", "required": true, "multi": true, "compositeSourceAttribute": "example-compositeSourceAttribute", "compositeSourceApplication": "Example Application"}], "config": {"key": "value"}, "features": ["example-value"], "propertyAttributes": ["example-value"], "csvAttributesMap": {"key": "value"}, "provisioningEnabled": true, "aggregationEnabled": true, "needsAggregationType": true, "creationRule": "example-creationRule", "customizationRule": "example-customizationRule", "correlationRule": "example-correlationRule", "refreshRule": "example-refreshRule", "supportsDisable": true, "disableFilterValue": "example-disableFilterValue", "supportsLock": true, "lockFilterValue": "example-lockFilterValue"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/applications/correlation:
post:
operationId: core_ApplicationsResource_createCorrelationConfig
tags:
- Applications
summary: Creates new CorrelationConfig
description: Creates new CorrelationConfig
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"appId": "abc-12345", "appType": "Identity", "objectType": "Identity"}
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/applications/correlation/configDetails:
get:
operationId: core_ApplicationsResource_getCorrelationConfigDetails
tags:
- Applications
summary: Returns AttributeBased and ConditionBased correlations for a selected config in Correlation tab under Add and Edit application screen
description: Returns AttributeBased and ConditionBased correlations for a selected config in Correlation tab under Add and Edit application screen
parameters:
- in: query
name: config
required: false
description: The config query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: CorrelationConfigDetailsDTO
example: {"correlationConfigId": "abc-12345", "attributeBasedCorrelations": [{"property": "example-property", "value": "example-value", "operation": "example-operation", "matchMode": "example-matchMode", "identityAttributeLabel": "example-identityAttributeLabel", "expression": "example-expression", "op": "example-op"}], "conditionBasedCorrelations": [{"identityId": "abc-12345", "identityDisplayableName": "Example Identitydisplayable", "filters": [{}], "expression": "example-expression", "filterResponseDTOS": [{}]}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/applications/correlation/{correlationConfigId}':
put:
operationId: core_ApplicationsResource_updateCorrelationConfig
tags:
- Applications
summary: Updates existing CorrelationConfig
description: Updates existing CorrelationConfig
parameters:
- in: path
name: correlationConfigId
required: true
description: The correlationConfigId.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"appId": "abc-12345", "appType": "Identity", "objectType": "Identity"}
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/applications/credentialCycling:
get:
operationId: core_ApplicationsResource_getCredentialCyclingStatus
tags:
- Applications
summary: Returns the credential cycling configuration status for the named application
description: Returns the credential cycling configuration status for the named application
parameters:
- in: query
name: appName
required: false
description: The appName query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: CredentialCyclingDTO
example: {"credentialConfiguration": true}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/applications/details/extendedAttributes:
get:
operationId: core_ApplicationsResource_getExtendedAttributes
tags:
- Applications
summary: This endpoint returns extended attributes details for application inside details tab in add / edit application flow
description: This endpoint returns extended attributes details for application inside details tab in add / edit application flow
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: ApplicationExtendedAttributesDTO
example: {"objectAttributeList": [{"attributeDetails": {}, "attributeValue": "example-attributeValue", "attributes": {"key": "value"}, "isLastExtendedAttribute": true}], "permissions": {"key": "value"}, "missingAttributesInfo": {"key": "value"}, "availableRights": [{}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/applications/filters:
get:
operationId: core_ApplicationsResource_getApplicationFilters
tags:
- Applications
summary: Get application filters
description: Get application filters
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: array
items:
type: object
example: [{"id": "12345", "name": "Example Item", "description": "Sample record"}]
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/applications/list:
post:
operationId: core_ApplicationsResource_getApplicationsList
tags:
- Applications
summary: 'This endpoint returns list of application definition objects in application definition page This also supports filters, start, limit,sort, dir and query'
description: 'This endpoint returns list of application definition objects in application definition page This also supports filters, start, limit,sort, dir and query'
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"appId": "abc-12345", "appType": "Identity", "objectType": "Identity"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: ApplicationDefinitionListResult
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Application", "type": "ExampleType"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/applications/managedAttributeDetails:
get:
operationId: core_ManagedAttributeDetailResource_getDetails
tags:
- Managed Attributes
summary: Get the details for the managed attribute
description: Get the details for the managed attribute
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: ManagedAttributeDetailDTO
example: {"id": "abc-12345", "application": "Example Application", "type": "ExampleType", "attribute": "example-attribute", "value": "example-value", "displayValue": "example-displayValue", "description": "A brief description.", "owner": "jsmith", "requestable": true, "iiqElevatedAccess": true, "extendedAttributes": {"key": "value"}, "groupAttributes": {"key": "value"}, "groupEntitlements": [{"nativeIdentity": "example-nativeIdentity", "accountName": "Example Account", "assigned": true, "grantedByRole": true, "startDate": "2024-01-01T00:00:00Z", "endDate": "2024-01-01T00:00:00Z", "lastCertDate": "2024-01-01T00:00:00Z", "lastCertName": "Example Lastcert", "lastCertificationItem": {}, "pendingCertificationItem": {}, "lastRequestItem": {}, "pendingRequestItem": {}, "assigner": "example-assigner", "source": "example-source", "foundOnAccount": true, "detectedRole": true, "hasPendingRequest": true, "pendingRequestId": "abc-12345", "allowed": true, "entitlementRequireEndDateTime": true, "entitlementMaxAccessTimeEnabled": true, "entitlementMaxAccessTimeValue": 0, "entitlementMaxAccessTimeUnit": "example-entitlementMaxAccessTimeUnit", "sourceAssignableRoleNames": ["example-value"], "sourceDetectableRoleNames": ["example-value"], "lastItem": {}, "pendingItem": {}}], "hasInheritance": true, "hasAccess": true, "hasMembers": true, "hasClassifications": true, "hasCloudAccess": true, "hasRoles": true}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/applications/managedAttributeDetails/access:
get:
operationId: core_TargetAssociationListResource_getAssociations
tags:
- Managed Attributes
summary: Get associations
description: Get associations
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/applications/managedAttributeDetails/cam/group:
get:
operationId: core_ManagedAttributeDetailResource_getGroup
tags:
- Managed Attributes
summary: Gets the sub resource for getting the CAM group details for this managed attribute
description: Gets the sub resource for getting the CAM group details for this managed attribute
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: CAMGroupDTO
example: {"errors": ["example-value"], "roles": [{"nativeId": "abc-12345", "cspType": "ExampleType", "displayName": "Example Display", "uri": "https://example.sailpoint.com", "adminCount": 1, "writeCount": 1, "readCount": 1, "scopes": [{}], "errors": ["example-value"], "camScopeDTO": {}}], "services": [{"name": "Example Item", "type": "ExampleType", "numResources": 0}], "uri": "https://example.sailpoint.com", "cspType": "ExampleType", "nativeId": "abc-12345", "displayName": "Example Display", "rolesList": {"items": [{}], "federatedRolesList": {}, "sb": {}}, "servicesList": {"items": [{}], "servicesList": {}, "sb": {}}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/applications/managedAttributeDetails/cam/scope:
get:
operationId: core_ManagedAttributeDetailResource_getScopeServices
tags:
- Managed Attributes
summary: Gets the sub resource for getting the CAM details for this managed attribute
description: Gets the sub resource for getting the CAM details for this managed attribute
parameters:
- in: query
name: uri
required: false
description: The uri query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/applications/managedAttributeDetails/cam/service:
get:
operationId: core_CAMResourcesListResource_getServiceResources
tags:
- UI CAM
summary: Get the list of CAM resources
description: Get the list of CAM resources
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/applications/managedAttributeDetails/classifications:
get:
operationId: core_ClassificationListResource_getClassifications
tags:
- Managed Attributes
summary: Public GET method to retrieve a ListResult of ClassificationDTOs
description: Public GET method to retrieve a ListResult of ClassificationDTOs
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/applications/managedAttributeDetails/inheritance/children:
get:
operationId: core_ManagedAttributeInheritanceListResource_getChildren
tags:
- Managed Attributes
summary: Gets the children managed attributes based on inheritance
description: Gets the children managed attributes based on inheritance
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/applications/managedAttributeDetails/inheritance/parents:
get:
operationId: core_ManagedAttributeInheritanceListResource_getParents
tags:
- Managed Attributes
summary: Gets the parent managed attributes based on inheritance
description: Gets the parent managed attributes based on inheritance
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/applications/managedAttributeDetails/members:
get:
operationId: core_AccountGroupMemberListResource_getMembers
tags:
- Account Groups
summary: Get the list of account group members
description: Get the list of account group members
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/applications/managedAttributeDetails/roles:
get:
operationId: core_AccountGroupRolesListResource_getRoles
tags:
- Account Groups
summary: Get the list of associated roles for ManagedAttribute
description: Get the list of associated roles for ManagedAttribute
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/applications/passwordPolicy/{policyId}':
get:
operationId: core_ApplicationsResource_getPasswordPolicy
tags:
- Applications
summary: This endpoint returns details of a password policy This will be called to get policy details for add existing policy functionality
description: This endpoint returns details of a password policy This will be called to get policy details for add existing policy functionality
parameters:
- in: path
name: policyId
required: true
description: The policyId.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: PasswordPolicyDTO
example: {"id": "abc-12345", "name": "Example Item", "description": "A brief description.", "constraints": {"key": "value"}, "shared": true}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/applications/passwordPolicy/{policyId}/constraints':
get:
operationId: core_ApplicationsResource_getConvertedConstraints
tags:
- Applications
summary: This endpoint returns readable converted constraints when user clicks on a policy in password policy dropdown through add existing policy functionality in password policy tab
description: This endpoint returns readable converted constraints when user clicks on a policy in password policy dropdown through add existing policy functionality in password policy tab
parameters:
- in: path
name: policyId
required: true
description: The policyId.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: array
items:
type: object
example: [{"id": "12345", "name": "Example Item", "description": "Sample record"}]
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/applications/preview:
post:
operationId: core_ApplicationsResource_getPreviewResponse
tags:
- Applications
summary: 'This method returns data for Preview functionality in Application''s Schema tab AppId - In case of existing application AppId should be sent as queryParam AppType - In case of new Application AppType s'
description: 'This method returns data for Preview functionality in Application''s Schema tab AppId - In case of existing application AppId should be sent as queryParam AppType - In case of new Application AppType s'
parameters:
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"appId": "abc-12345", "appType": "Identity", "objectType": "Identity"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/applications/restricted/suggest/suggest/column/{class}/{column}':
post:
operationId: core_SuggestResource_getDistinctColumnSuggest_4
tags:
- Suggest
summary: Get distinct column suggest
description: Get distinct column suggest
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
- in: path
name: column
required: true
description: The column.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/applications/restricted/suggest/suggest/object/{class}':
post:
operationId: core_SuggestResource_getSuggest_4
tags:
- Suggest
summary: Returns a json data feed for a suggest component for the given class type
description: Returns a json data feed for a suggest component for the given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
get:
operationId: core_SuggestResource_simpleList_4
tags:
- Suggest
summary: Simple list
description: Simple list
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/applications/restricted/suggest/suggest/uiconfig:
post:
operationId: core_SuggestResource_getUIConfigSuggest_4
tags:
- Suggest
summary: Get ui config suggest
description: Get ui config suggest
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/applications/settings:
get:
operationId: core_ApplicationsResource_getAppSettings
tags:
- Applications
summary: Retrieves application settings for a given application
description: Retrieves application settings for a given application
parameters:
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: ApplicationSettingsUIModelDTO
example: {"data": {"key": "value"}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/applications/settings/attributeConfig:
get:
operationId: core_ApplicationsResource_getAttributeConfigByAppType
tags:
- Applications
summary: 'This endpoint returns list of AppSettingsFieldDTO according to appId or appType appId - in case of existing application appId should be sent as queryParam appType - in case of new application appType '
description: 'This endpoint returns list of AppSettingsFieldDTO according to appId or appType appId - in case of existing application appId should be sent as queryParam appType - in case of new application appType '
parameters:
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: AppSettingsFieldListDTO
example: {"fieldList": [{"name": "Example Item", "displayName": "Example Display", "type": "ExampleType", "required": true, "defaultValue": "example-defaultValue"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/applications/settings/discoverDomains:
post:
operationId: core_ApplicationsResource_getDomainDataList
tags:
- Applications
summary: 'This endpoint returns list of DomainData according to forestDataMap and appId or appType appId - in case of existing application appId should be sent as queryParam appType - in case of new application'
description: 'This endpoint returns list of DomainData according to forestDataMap and appId or appType appId - in case of existing application appId should be sent as queryParam appType - in case of new application'
parameters:
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"appId": "abc-12345", "appType": "Identity", "objectType": "Identity"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: DomainDataListDTO
example: {"domainSettings": [{"forestName": "Example Forest", "domainDN": "example-domainDN", "domainNetBiosName": "Example Domainnetbios", "enablePasswordLessAuthenticationForDomain": true, "user": "example-user", "password": "**hidden**", "servers": ["example-value"], "authenticationType": "ExampleType", "useSSL": true}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/applications/settings/discoverTargetHosts:
post:
operationId: core_ApplicationsResource_getTargetHosts
tags:
- Applications
summary: 'This endpoint returns list of SuggestDTO containing target host name and displayName according to discoverHostsPayload and appId or appType appId - in case of existing application appId should be sent'
description: 'This endpoint returns list of SuggestDTO containing target host name and displayName according to discoverHostsPayload and appId or appType appId - in case of existing application appId should be sent'
parameters:
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"appId": "abc-12345", "appType": "Identity", "objectType": "Identity"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/applications/status:
get:
operationId: core_ApplicationsResource_getApplicationsStatus
tags:
- Applications
summary: Get applications status
description: Get applications status
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/applications/suggest/suggest/column/{class}/{column}':
post:
operationId: core_SuggestResource_getDistinctColumnSuggest_5
tags:
- Suggest
summary: Get distinct column suggest
description: Get distinct column suggest
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
- in: path
name: column
required: true
description: The column.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/applications/suggest/suggest/object/{class}':
post:
operationId: core_SuggestResource_getSuggest_5
tags:
- Suggest
summary: Returns a json data feed for a suggest component for the given class type
description: Returns a json data feed for a suggest component for the given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
get:
operationId: core_SuggestResource_simpleList_5
tags:
- Suggest
summary: Simple list
description: Simple list
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/applications/suggest/suggest/uiconfig:
post:
operationId: core_SuggestResource_getUIConfigSuggest_5
tags:
- Suggest
summary: Get ui config suggest
description: Get ui config suggest
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/applications/tabs:
get:
operationId: core_ApplicationsResource_getTabDetails
tags:
- Applications
summary: Responsible for sending tabs that needs to be displayed in UI while creating a New App or Editing Existing App
description: Responsible for sending tabs that needs to be displayed in UI while creating a New App or Editing Existing App
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/applications/targetSource/{name}':
get:
operationId: core_ApplicationsResource_getTargetSourceByName
tags:
- Applications
summary: Returns TargetSource based on the selected value from targetSource dropdown
description: Returns TargetSource based on the selected value from targetSource dropdown
parameters:
- in: path
name: name
required: true
description: The name.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: UnstructuredTargetDTO
example: {"id": "abc-12345", "name": "Example Item", "description": "A brief description.", "correlationRule": "example-correlationRule", "creationRule": "example-creationRule", "refreshRule": "example-refreshRule", "collector": "example-collector", "modified": "2024-01-01T00:00:00Z", "configuration": {"key": "value"}, "attributeValue": "example-attributeValue"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/applications/testConnection:
post:
operationId: core_ApplicationsResource_testConnection
tags:
- Applications
summary: 'This method is for TestConnection functionality in Application Settings tab AppId - In case of existing application AppId should be sent as queryParam AppType - In case of new Application AppType shou'
description: 'This method is for TestConnection functionality in Application Settings tab AppId - In case of existing application AppId should be sent as queryParam AppType - In case of new Application AppType shou'
parameters:
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"appId": "abc-12345", "appType": "Identity", "objectType": "Identity"}
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/applications/unstructuredTargets/discoverHosts:
post:
operationId: core_ApplicationsResource_discoverHosts
tags:
- Applications
summary: This method is for TestConnection functionality in Application Unstructured Targets tab
description: This method is for TestConnection functionality in Application Unstructured Targets tab
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"appId": "abc-12345", "appType": "Identity", "objectType": "Identity"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/applications/unstructuredTargets/testConnection:
post:
operationId: core_ApplicationsResource_testConnectionForUnstructuredTargets
tags:
- Applications
summary: This method is for TestConnection functionality in Application Unstructured Targets tab
description: This method is for TestConnection functionality in Application Unstructured Targets tab
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"appId": "abc-12345", "appType": "Identity", "objectType": "Identity"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/applications/validateReconfigure:
post:
operationId: core_ApplicationsResource_validateReconfigure
tags:
- Applications
summary: 'Validates connector rules for an application type change before save, using the {'
description: 'Validates connector rules for an application type change before save, using the {'
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"appId": "abc-12345", "appType": "Identity", "objectType": "Identity"}
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/applications/{appId}':
delete:
operationId: core_ApplicationsResource_deleteApplication
tags:
- Applications
summary: This endpoint deletes the application according to the app id
description: This endpoint deletes the application according to the app id
parameters:
- in: path
name: appId
required: true
description: The appId.
schema:
type: string
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
get:
operationId: core_ApplicationsResource_getExistingApplicationData
tags:
- Applications
summary: This endpoint returns ApplicationModelDTO data for existing application in add / edit application flow
description: This endpoint returns ApplicationModelDTO data for existing application in add / edit application flow
parameters:
- in: path
name: appId
required: true
description: The appId.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: ApplicationModelDTO
example: {"details": {"appId": "abc-12345", "name": "Example Item", "revoker": {}, "owner": {}, "proxyApplication": "Example Application", "applicationType": "ExampleType", "profileClass": "sailpoint.object.Identity", "descriptions": {"key": "value"}, "scope": {}, "authoritativeApplication": true, "caseInsensitive": true, "maintenanceEnabled": true, "maintenanceExpiration": 0, "extendedAttributes": {}}, "configuration": {"schemas": {}, "provisioningPolicies": {}}, "correlation": {"accountCorrelationConfig": "example-accountCorrelationConfig", "correlationId": "abc-12345", "existingCorrelationConfigs": [{}], "attributeBasedCorrelations": [{}], "conditionBasedCorrelations": [{}], "managerCorrelationFilter": {}}, "scoreCard": {"scoreItem": {}, "typeName": "Example Type", "targetMsg": {}, "index": {}, "scores": [{}], "scoreItems": [{}], "i": [{}], "used": {}, "parent": "example-parent", "raw": {}, "categoryDisplayName": "Example Categorydisplay", "category": "example-category", "scoreColorMap": {"key": "value"}, "compensatedScoreColorMap": {"key": "value"}, "params": [{}], "displayableNames": ["example-value"], "msg": "example-msg"}, "activityDataSources": {"activityDataSourceList": [{}]}, "unstructuredTargets": {"unstructuredTargetList": [{}]}, "rules": {"aggregationRules": [{}], "provisioningRules": [{}], "schemaRules": {"key": "value"}}, "passwordPolicy": {"passwordPolicyList": [{}], "passwordPolicyExist": true}, "preferences": {"enableLocalizeApplicationDescriptions": true, "locale": {}, "resolvedApplicationType": "ExampleType"}, "attributes": {"key": "value"}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
put:
operationId: core_ApplicationsResource_updateApplication
tags:
- Applications
summary: Updates an existing application with the provided data
description: Updates an existing application with the provided data
parameters:
- in: path
name: appId
required: true
description: The appId.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
- in: query
name: validateOnly
required: false
description: The validateOnly query parameter.
schema:
type: string
default: "false"
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"appId": "abc-12345", "appType": "Identity", "objectType": "Identity"}
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/applications/{appId}/passwordPolicy':
get:
operationId: core_ApplicationsResource_getPasswordPolicyHolder
tags:
- Applications
summary: This endpoint returns details of a password policy holder which contains data of password policy details and identity selector
description: This endpoint returns details of a password policy holder which contains data of password policy details and identity selector
parameters:
- in: path
name: appId
required: true
description: The appId.
schema:
type: string
- in: query
name: policyHolderId
required: false
description: The policyHolderId query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: PasswordPolicyHolderDTO
example: {"policyHolderId": "abc-12345", "passwordPolicy": {"id": "abc-12345", "name": "Example Item", "description": "A brief description.", "constraints": {"key": "value"}, "shared": true}, "identitySelector": {"matchExpression": {}, "filter": "example-filter", "script": {}, "rule": {"key": "value"}, "population": {"key": "value"}}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/applications/{application}':
get:
operationId: core_ApplicationResource_getApplicationDTO
tags:
- Applications
summary: Get application dto
description: Get application dto
parameters:
- in: path
name: application
required: true
description: The application path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: ApplicationDTO
example: {"id": "abc-12345", "name": "Example Item", "description": "A brief description.", "type": "ExampleType", "owner": {"id": "abc-12345", "name": "Example Item", "displayName": "Example Display"}, "remediators": [{"id": "abc-12345", "name": "Example Item", "displayName": "Example Display"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
put:
operationId: core_ApplicationResource_updateApplication
tags:
- Applications
summary: Update application
description: Update application
parameters:
- in: path
name: application
required: true
description: The application path parameter.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"dir": "ASC", "query": "name sw \"example\"", "sort": "ASC"}
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/applications/{application}/instances':
get:
operationId: core_ApplicationResource_getInstances
tags:
- Applications
summary: Return a list of the instances for this application
description: Return a list of the instances for this application
parameters:
- in: path
name: application
required: true
description: The application path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/applications/{application}/links':
get:
operationId: core_LinksResource_getLinks
tags:
- Applications
summary: 'Return the links on the identity, optionally filtering by application and instance'
description: 'Return the links on the identity, optionally filtering by application and instance'
parameters:
- in: path
name: application
required: true
description: The application path parameter.
schema:
type: string
- in: query
name: application
required: false
description: The application query parameter.
schema:
type: string
- in: query
name: instance
required: false
description: The instance query parameter.
schema:
type: string
- in: query
name: includeLinkState
required: false
description: The includeLinkState query parameter.
schema:
type: boolean
- in: query
name: action
required: false
description: The action query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/applications/{application}/links/accountsGrid':
get:
operationId: core_LinksResource_getApplicationAccountsGrid
tags:
- Applications
summary: Return a list result that contains the accounts on this application
description: Return a list result that contains the accounts on this application
parameters:
- in: path
name: application
required: true
description: The application path parameter.
schema:
type: string
- in: query
name: query
required: false
description: The query query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/applications/{application}/links/accountsGrid/{linkId}':
get:
operationId: core_LinksResource_getApplicationAccountsGridForLinkId
tags:
- Applications
summary: Return a list result that contains the link details for an account in an application
description: Return a list result that contains the link details for an account in an application
parameters:
- in: path
name: application
required: true
description: The application path parameter.
schema:
type: string
- in: path
name: linkId
required: true
description: The linkId.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/applications/{application}/links/manageAccountsGrid':
get:
operationId: core_LinksResource_getManageAccountsGrid
tags:
- Applications
summary: Return a grid compatible list of links that belong to the given identity
description: Return a grid compatible list of links that belong to the given identity
parameters:
- in: path
name: application
required: true
description: The application path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/applications/{application}/links/managePasswordsGrid':
get:
operationId: core_LinksResource_getManagePasswordsGrid
tags:
- Applications
summary: Return a grid compatible list of links that belong to the given identity
description: Return a grid compatible list of links that belong to the given identity
parameters:
- in: path
name: application
required: true
description: The application path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/applications/{application}/schemaAttributes':
get:
operationId: core_ApplicationResource_getApplicationSchemaAttributes
tags:
- Applications
summary: Get application schema attributes
description: Get application schema attributes
parameters:
- in: path
name: application
required: true
description: The application path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/applications/{application}/status':
get:
operationId: core_ApplicationResource_getApplicationStatus
tags:
- Applications
summary: Get application status
description: Get application status
parameters:
- in: path
name: application
required: true
description: The application path parameter.
schema:
type: string
- in: query
name: includeRequests
required: false
description: The includeRequests query parameter.
schema:
type: boolean
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: ApplicationStatusDTO
example: {"statuses": [{}], "server": "example-server", "status": true, "ping": "example-ping", "outstandingRequest": true, "applicationName": "Example Application", "exceptionMessage": "Example message text"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: core_ApplicationResource_requestApplicationStatus
tags:
- Applications
summary: Request application status
description: Request application status
parameters:
- in: path
name: application
required: true
description: The application path parameter.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"dir": "ASC", "query": "name sw \"example\"", "sort": "ASC"}
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/applications/{application}/summary':
get:
operationId: core_ApplicationResource_getSummary
tags:
- Applications
summary: Return a list of the instances for this application
description: Return a list of the instances for this application
parameters:
- in: path
name: application
required: true
description: The application path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
object:
type: object
description: The returned object
example: {"object": {"id": "abc-12345", "name": "Example Item"}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/applications/{application}/testConnector/{objectType}':
get:
operationId: core_ApplicationResource_testConnector
tags:
- Applications
summary: Return the first 10 resource objects for the given application and object type
description: Return the first 10 resource objects for the given application and object type
parameters:
- in: path
name: application
required: true
description: The application path parameter.
schema:
type: string
- in: path
name: objectType
required: true
description: The objectType.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/asyncRequest:
post:
operationId: core_AsyncRequestResource_createAsyncRequest
tags:
- Async Requests
summary: Creates an asynchronous request based on provided input data
description: Creates an asynchronous request based on provided input data
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"data": "example-data"}
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/asyncRequest/command:
post:
operationId: core_AsyncRequestResource_command
tags:
- Async Requests
summary: Command
description: Command
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"data": "example-data"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/asyncRequest/list:
post:
operationId: core_AsyncRequestResource_getAsyncRequests
tags:
- Async Requests
summary: Generic API to fetch results from AsyncRequest table based on asyncRequestType
description: Generic API to fetch results from AsyncRequest table based on asyncRequestType
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"data": "example-data"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/attachment:
post:
operationId: core_AttachmentResource_uploadFile
tags:
- Attachments
summary: Saves the given file to the database if attachments are enabled
description: Saves the given file to the database if attachments are enabled
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"accessRequest": "Example Role", "addedEntitlements": "Example Role", "addedRoles": "Example Role", "asdf": "example-asdf", "attachments": "example-attachments", "description": "Example description", "id": "abc-12345", "identities": "abc-12345", "type": "Identity"}
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/attachment/{attachmentId}':
get:
operationId: core_AttachmentResource_getFile
tags:
- Attachments
summary: Get file
description: Get file
parameters:
- in: path
name: attachmentId
required: true
description: The attachmentId.
schema:
type: string
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
patch:
operationId: core_AttachmentResource_setFileDescription
tags:
- Attachments
summary: Sets the description of an attachment to the given value
description: Sets the description of an attachment to the given value
parameters:
- in: path
name: attachmentId
required: true
description: The attachmentId.
schema:
type: string
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
delete:
operationId: core_AttachmentResource_removeFile
tags:
- Attachments
summary: Remove attachment file from the database
description: Remove attachment file from the database
parameters:
- in: path
name: attachmentId
required: true
description: The attachmentId.
schema:
type: string
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/authentication:
get:
operationId: core_IIQResource_authentication
tags:
- IIQ
summary: Attempt authentication using the credentials for this request
description: Attempt authentication using the credentials for this request
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"success": "example-success"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/byItem:
get:
operationId: core_IdentityHistoryResource_getIdentityHistoryByItem
tags:
- Identities
summary: 'Return the history items for the identity on the given cert item, filtering as needed'
description: 'Return the history items for the identity on the given cert item, filtering as needed'
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/certEntity/{entity}/entitlements':
get:
operationId: core_CertificationEntityResource_getEntitlements
tags:
- Certifications
summary: Get entitlements
description: Get entitlements
parameters:
- in: path
name: entity
required: true
description: The entity.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/certEntity/{entity}/profiles':
get:
operationId: core_CertificationEntityResource_getProfiles
tags:
- Certifications
summary: Get profiles
description: Get profiles
parameters:
- in: path
name: entity
required: true
description: The entity.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/certEntity/{entity}/relatedroles':
get:
operationId: core_CertificationEntityResource_getRelatedRoles
tags:
- Certifications
summary: Get related roles
description: Get related roles
parameters:
- in: path
name: entity
required: true
description: The entity.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/certEntity/{entity}/roles':
get:
operationId: core_CertificationEntityResource_getRoles
tags:
- Certifications
summary: Get roles
description: Get roles
parameters:
- in: path
name: entity
required: true
description: The entity.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/certEntity/{entity}/summary':
get:
operationId: core_CertificationEntityResource_getSummary
tags:
- Certifications
summary: Get summary
description: Get summary
parameters:
- in: path
name: entity
required: true
description: The entity.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/certEntity/{entity}/violations':
get:
operationId: core_CertificationEntityResource_getViolations
tags:
- Certifications
summary: Get violations
description: Get violations
parameters:
- in: path
name: entity
required: true
description: The entity.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/certItem:
get:
operationId: core_CertificationItemResource_getSummary
tags:
- Certifications
summary: Get summary
description: Get summary
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/certItem/appSummary/{application}':
get:
operationId: core_CertificationItemResource_getAppSummary
tags:
- Certifications
summary: Get app summary
description: Get app summary
parameters:
- in: path
name: application
required: true
description: The application.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
object:
type: object
description: The returned object
example: {"object": {"id": "abc-12345", "name": "Example Item"}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/certItem/challengeDetails:
get:
operationId: core_CertificationItemResource_getChallengeDetails
tags:
- Certifications
summary: Get challenge details
description: Get challenge details
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/certItem/itemClassification:
post:
operationId: core_CertificationItemResource_setItemClassificationData
tags:
- Certifications
summary: Set item classification data
description: Set item classification data
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/certItem/missingRolesAdvice:
get:
operationId: core_CertificationItemResource_getMissingRolesRemediationAdvice
tags:
- Certifications
summary: Get missing roles remediation advice
description: Get missing roles remediation advice
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/certItem/remediationAdvice:
get:
operationId: core_CertificationItemResource_getViolationRemediationAdvice
tags:
- Certifications
summary: Get violation remediation advice
description: Get violation remediation advice
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/certItem/revokableRoles:
get:
operationId: core_CertificationItemResource_getRevokableRoles
tags:
- Certifications
summary: Get revokable roles
description: Get revokable roles
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/certItem/summary:
post:
operationId: core_CertificationItemResource_getRemediationSummary
tags:
- Certifications
summary: Get remediation summary
description: Get remediation summary
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/certItem/{action}':
get:
operationId: core_CertificationItemResource_calculateSummary
tags:
- Certifications
summary: Calculate summary
description: Calculate summary
parameters:
- in: path
name: action
required: true
description: The action.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/certItem/{id}/entitlementComment':
post:
operationId: core_CertificationItemResource_postEntitlementComment
tags:
- Certifications
summary: 'Add an entitlement comment to the identity''s history'
description: 'Add an entitlement comment to the identity''s history'
parameters:
- in: path
name: id
required: true
description: The id.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/certification/item/{itemId}/certItem':
get:
operationId: core_CertificationItemResource_getSummary_2
tags:
- Certifications
summary: Get summary
description: Get summary
parameters:
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/certification/item/{itemId}/certItem/appSummary/{application}':
get:
operationId: core_CertificationItemResource_getAppSummary_2
tags:
- Certifications
summary: Get app summary
description: Get app summary
parameters:
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: application
required: true
description: The application.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
object:
type: object
description: The returned object
example: {"object": {"id": "abc-12345", "name": "Example Item"}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/certification/item/{itemId}/certItem/challengeDetails':
get:
operationId: core_CertificationItemResource_getChallengeDetails_2
tags:
- Certifications
summary: Get challenge details
description: Get challenge details
parameters:
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/certification/item/{itemId}/certItem/itemClassification':
post:
operationId: core_CertificationItemResource_setItemClassificationData_2
tags:
- Certifications
summary: Set item classification data
description: Set item classification data
parameters:
- in: path
name: itemId
required: true
description: The itemId.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/certification/item/{itemId}/certItem/missingRolesAdvice':
get:
operationId: core_CertificationItemResource_getMissingRolesRemediationAdvice_2
tags:
- Certifications
summary: Get missing roles remediation advice
description: Get missing roles remediation advice
parameters:
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/certification/item/{itemId}/certItem/remediationAdvice':
get:
operationId: core_CertificationItemResource_getViolationRemediationAdvice_2
tags:
- Certifications
summary: Get violation remediation advice
description: Get violation remediation advice
parameters:
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/certification/item/{itemId}/certItem/revokableRoles':
get:
operationId: core_CertificationItemResource_getRevokableRoles_2
tags:
- Certifications
summary: Get revokable roles
description: Get revokable roles
parameters:
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/certification/item/{itemId}/certItem/summary':
post:
operationId: core_CertificationItemResource_getRemediationSummary_2
tags:
- Certifications
summary: Get remediation summary
description: Get remediation summary
parameters:
- in: path
name: itemId
required: true
description: The itemId.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/certification/item/{itemId}/certItem/{action}':
get:
operationId: core_CertificationItemResource_calculateSummary_2
tags:
- Certifications
summary: Calculate summary
description: Calculate summary
parameters:
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: action
required: true
description: The action.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/certification/item/{itemId}/certItem/{id}/entitlementComment':
post:
operationId: core_CertificationItemResource_postEntitlementComment_2
tags:
- Certifications
summary: 'Add an entitlement comment to the identity''s history'
description: 'Add an entitlement comment to the identity''s history'
parameters:
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: id
required: true
description: The id.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/certification/{certificationId}/bulkdecision/{action}':
get:
operationId: core_CertificationResource_getBulkDecisionDetails
tags:
- Certifications
summary: Returns decision details for a bulk action
description: Returns decision details for a bulk action
parameters:
- in: path
name: certificationId
required: true
description: The certificationId.
schema:
type: string
- in: path
name: action
required: true
description: The action.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/certification/{certificationId}/bulkdecision/{entityId}/{action}':
get:
operationId: core_CertificationResource_getBulkEntityDecisionDetails
tags:
- Certifications
summary: Returns decision details for a bulk entity action
description: Returns decision details for a bulk entity action
parameters:
- in: path
name: certificationId
required: true
description: The certificationId.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId.
schema:
type: string
- in: path
name: action
required: true
description: The action.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/certification/{certificationId}/decisions':
post:
operationId: core_CertificationResource_makeDecisions
tags:
- Certifications
summary: Expects a list of Decision objects and creates the various CertificationActions for them
description: Expects a list of Decision objects and creates the various CertificationActions for them
parameters:
- in: path
name: certificationId
required: true
description: The certificationId.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/certification/{certificationId}/revocations':
get:
operationId: core_CertificationRevocationResource_getCompletedRevocations_2
tags:
- Certifications
summary: Return the revoked items for this certification
description: Return the revoked items for this certification
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/certificationGroups:
post:
operationId: core_CertificationGroupListResource_list
tags:
- Certification Groups
summary: List
description: List
requestBody:
content:
application/json:
schema:
type: object
description: MultivaluedMap
example: {"tags": "example-tags"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/certificationGroups/{groupId}/forward':
post:
operationId: core_CertificationGroupResource_forward
tags:
- Certification Groups
summary: Forward
description: Forward
parameters:
- in: path
name: groupId
required: true
description: The groupId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/certifications:
get:
operationId: core_CertificationListResource_list
tags:
- Certifications
summary: List
description: List
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/certifications/search:
post:
operationId: core_CertificationListResource_search
tags:
- Certifications
summary: Search
description: Search
requestBody:
content:
application/json:
schema:
type: object
description: MultivaluedMap
example: {"certifiers": "example-certifiers", "tags": "example-tags"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/checkAuthorization:
get:
operationId: core_IdentityResource_checkAuthorization
tags:
- Identities
summary: Check whether the request identity has the given right
description: Check whether the request identity has the given right
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"application": "Example Application", "colKey": "example-colKey", "nativeIdentity": "abc-12345", "roleId": "abc-12345", "showNonMatched": "example-showNonMatched", "teamsUserId": "abc-12345"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/config/rights:
get:
operationId: core_ConfigurationResource_getRightConfig
tags:
- Configuration
summary: Get right config
description: Get right config
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/configuration:
get:
operationId: core_IIQResource_getConfiguration
tags:
- IIQ
summary: 'Retrieve a SystemConfiguration attribute''s value'
description: 'Retrieve a SystemConfiguration attribute''s value'
parameters:
- in: query
name: attributeName
required: false
description: The attributeName query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: Object
example: {"id": "12345", "name": "Example Item", "description": "Sample record"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/debug/Cache:
get:
operationId: core_DebugResource_viewCache
tags:
- Debug
summary: View cache
description: View cache
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/debug/Cache/reset:
get:
operationId: core_DebugResource_resetCache
tags:
- Debug
summary: Reset cache
description: Reset cache
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/debug/Identity/clearPreferences:
post:
operationId: core_DebugResource_newObject
tags:
- Debug
summary: New object
description: New object
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/debug/Rule/{id}/run':
get:
operationId: core_DebugResource_updateObject
tags:
- Debug
summary: Update object
description: Update object
parameters:
- in: path
name: id
required: true
description: The id.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/debug/bulkDelete/{class}':
post:
operationId: core_DebugResource_deleteObjects
tags:
- Debug
summary: Delete objects
description: Delete objects
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
description: MultivaluedMap
example: {"Password": "**hidden**", "query": "name sw \"example\"", "readOnly": "example-readOnly", "selectAll": "example-selectAll"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/debug/meters:
get:
operationId: core_DebugResource_meters
tags:
- Debug
summary: Returns call timing information for all meters
description: Returns call timing information for all meters
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/debug/phaseCertification:
post:
operationId: core_DebugResource_phaseCertification
tags:
- Debug
summary: Phase certification
description: Phase certification
requestBody:
content:
application/json:
schema:
type: object
description: MultivaluedMap
example: {"Password": "**hidden**", "readOnly": "example-readOnly"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/debug/{class}':
get:
operationId: core_DebugResource_listObjects
tags:
- Debug
summary: List objects
description: List objects
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: core_DebugResource_newObject_2
tags:
- Debug
summary: New object
description: New object
parameters:
- in: path
name: class
required: true
description: The class path parameter.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
description: MultivaluedMap
example: {"Password": "**hidden**", "readOnly": "example-readOnly"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/debug/{class}/{id}':
get:
operationId: core_DebugResource_getObject
tags:
- Debug
summary: Get object
description: Get object
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
- in: path
name: id
required: true
description: The id.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: core_DebugResource_updateObject_2
tags:
- Debug
summary: Update object
description: Update object
parameters:
- in: path
name: class
required: true
description: The class path parameter.
schema:
type: string
- in: path
name: id
required: true
description: The id.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/dynamicScopes:
get:
operationId: core_DynamicScopeListResource_getList
tags:
- Dynamic Scopes
summary: Return a ListResult of all DynamicScopes with name and id
description: Return a ListResult of all DynamicScopes with name and id
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: core_DynamicScopeListResource_createDynamicScope
tags:
- Dynamic Scopes
summary: Creates a new DynamicScope object based on passed in data map
description: Creates a new DynamicScope object based on passed in data map
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"ds": {}, "name": "Example Item", "description": "A brief description.", "populationRequestControlMap": {"key": "value"}, "inclusions": ["example-value"], "exclusions": ["example-value"], "roleRequestControlId": "abc-12345", "roleRequestControlName": "Example Rolerequestcontrol", "applicationRequestControlId": "abc-12345", "applicationRequestControlName": "Example Applicationrequestcontrol", "managedAttributeRequestControlId": "abc-12345", "managedAttributeRequestControlName": "Example Managedattributerequestcontrol", "roleRemoveControlId": "abc-12345", "roleRemoveControlName": "Example Roleremovecontrol", "applicationRemoveControlId": "abc-12345", "applicationRemoveControlName": "Example Applicationremovecontrol", "managedAttributeRemoveControlId": "abc-12345", "managedAttributeRemoveControlName": "Example Managedattributeremovecontrol", "quickLinkOptionsList": [{}], "clazz": {}, "definitionType": "ExampleType", "popAuthority": {}, "matchConfig": {}, "jsonData": "example-jsonData", "id": "abc-12345", "popRequest": {}, "attributeControlFilter": "example-attributeControlFilter", "attributeFilterControl": {}, "filterGenerationRuleName": "Example Filtergenerationrule", "iList": [{}], "exculsionList": [{}], "inculsionList": [{}], "identityList": [{}], "retList": [{}], "rule": {}, "map": {"key": "value"}, "selector": {}, "qlo": {}, "mapper": {}, "root": {}, "filterClass": {}}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"ds": {}, "name": "Example Item", "description": "A brief description.", "populationRequestControlMap": {"key": "value"}, "inclusions": ["example-value"], "exclusions": ["example-value"], "roleRequestControlId": "abc-12345", "roleRequestControlName": "Example Rolerequestcontrol", "applicationRequestControlId": "abc-12345", "applicationRequestControlName": "Example Applicationrequestcontrol", "managedAttributeRequestControlId": "abc-12345", "managedAttributeRequestControlName": "Example Managedattributerequestcontrol", "roleRemoveControlId": "abc-12345", "roleRemoveControlName": "Example Roleremovecontrol", "applicationRemoveControlId": "abc-12345", "applicationRemoveControlName": "Example Applicationremovecontrol", "managedAttributeRemoveControlId": "abc-12345", "managedAttributeRemoveControlName": "Example Managedattributeremovecontrol", "quickLinkOptionsList": [{}], "clazz": {}, "definitionType": "ExampleType", "popAuthority": {}, "matchConfig": {}, "jsonData": "example-jsonData", "id": "abc-12345", "popRequest": {}, "attributeControlFilter": "example-attributeControlFilter", "attributeFilterControl": {}, "filterGenerationRuleName": "Example Filtergenerationrule", "iList": [{}], "exculsionList": [{}], "inculsionList": [{}], "identityList": [{}], "retList": [{}], "rule": {}, "map": {"key": "value"}, "selector": {}, "qlo": {}, "mapper": {}, "root": {}, "filterClass": {}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/dynamicScopes/{dynamicScopeId}':
get:
operationId: core_DynamicScopeResource_getSummaryJson
tags:
- Dynamic Scopes
summary: Gets the details for this dynamic scope (ipop)
description: Gets the details for this dynamic scope (ipop)
parameters:
- in: path
name: dynamicScopeId
required: true
description: The dynamicScopeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"ds": {}, "name": "Example Item", "description": "A brief description.", "populationRequestControlMap": {"key": "value"}, "inclusions": ["example-value"], "exclusions": ["example-value"], "roleRequestControlId": "abc-12345", "roleRequestControlName": "Example Rolerequestcontrol", "applicationRequestControlId": "abc-12345", "applicationRequestControlName": "Example Applicationrequestcontrol", "managedAttributeRequestControlId": "abc-12345", "managedAttributeRequestControlName": "Example Managedattributerequestcontrol", "roleRemoveControlId": "abc-12345", "roleRemoveControlName": "Example Roleremovecontrol", "applicationRemoveControlId": "abc-12345", "applicationRemoveControlName": "Example Applicationremovecontrol", "managedAttributeRemoveControlId": "abc-12345", "managedAttributeRemoveControlName": "Example Managedattributeremovecontrol", "quickLinkOptionsList": [{}], "clazz": {}, "definitionType": "ExampleType", "popAuthority": {}, "matchConfig": {}, "jsonData": "example-jsonData", "id": "abc-12345", "popRequest": {}, "attributeControlFilter": "example-attributeControlFilter", "attributeFilterControl": {}, "filterGenerationRuleName": "Example Filtergenerationrule", "iList": [{}], "exculsionList": [{}], "inculsionList": [{}], "identityList": [{}], "retList": [{}], "rule": {}, "map": {"key": "value"}, "selector": {}, "qlo": {}, "mapper": {}, "root": {}, "filterClass": {}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
put:
operationId: core_DynamicScopeResource_updateDynamicScope_2
tags:
- Dynamic Scopes
summary: Updates the specified DynamicScope object with passed in data map
description: Updates the specified DynamicScope object with passed in data map
parameters:
- in: path
name: dynamicScopeId
required: true
description: The dynamicScopeId path parameter.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"ds": {}, "name": "Example Item", "description": "A brief description.", "populationRequestControlMap": {"key": "value"}, "inclusions": ["example-value"], "exclusions": ["example-value"], "roleRequestControlId": "abc-12345", "roleRequestControlName": "Example Rolerequestcontrol", "applicationRequestControlId": "abc-12345", "applicationRequestControlName": "Example Applicationrequestcontrol", "managedAttributeRequestControlId": "abc-12345", "managedAttributeRequestControlName": "Example Managedattributerequestcontrol", "roleRemoveControlId": "abc-12345", "roleRemoveControlName": "Example Roleremovecontrol", "applicationRemoveControlId": "abc-12345", "applicationRemoveControlName": "Example Applicationremovecontrol", "managedAttributeRemoveControlId": "abc-12345", "managedAttributeRemoveControlName": "Example Managedattributeremovecontrol", "quickLinkOptionsList": [{}], "clazz": {}, "definitionType": "ExampleType", "popAuthority": {}, "matchConfig": {}, "jsonData": "example-jsonData", "id": "abc-12345", "popRequest": {}, "attributeControlFilter": "example-attributeControlFilter", "attributeFilterControl": {}, "filterGenerationRuleName": "Example Filtergenerationrule", "iList": [{}], "exculsionList": [{}], "inculsionList": [{}], "identityList": [{}], "retList": [{}], "rule": {}, "map": {"key": "value"}, "selector": {}, "qlo": {}, "mapper": {}, "root": {}, "filterClass": {}}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"ds": {}, "name": "Example Item", "description": "A brief description.", "populationRequestControlMap": {"key": "value"}, "inclusions": ["example-value"], "exclusions": ["example-value"], "roleRequestControlId": "abc-12345", "roleRequestControlName": "Example Rolerequestcontrol", "applicationRequestControlId": "abc-12345", "applicationRequestControlName": "Example Applicationrequestcontrol", "managedAttributeRequestControlId": "abc-12345", "managedAttributeRequestControlName": "Example Managedattributerequestcontrol", "roleRemoveControlId": "abc-12345", "roleRemoveControlName": "Example Roleremovecontrol", "applicationRemoveControlId": "abc-12345", "applicationRemoveControlName": "Example Applicationremovecontrol", "managedAttributeRemoveControlId": "abc-12345", "managedAttributeRemoveControlName": "Example Managedattributeremovecontrol", "quickLinkOptionsList": [{}], "clazz": {}, "definitionType": "ExampleType", "popAuthority": {}, "matchConfig": {}, "jsonData": "example-jsonData", "id": "abc-12345", "popRequest": {}, "attributeControlFilter": "example-attributeControlFilter", "attributeFilterControl": {}, "filterGenerationRuleName": "Example Filtergenerationrule", "iList": [{}], "exculsionList": [{}], "inculsionList": [{}], "identityList": [{}], "retList": [{}], "rule": {}, "map": {"key": "value"}, "selector": {}, "qlo": {}, "mapper": {}, "root": {}, "filterClass": {}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
delete:
operationId: core_DynamicScopeResource_deleteDynamicScope_2
tags:
- Dynamic Scopes
summary: Removes the specified dynamic scope object
description: Removes the specified dynamic scope object
parameters:
- in: path
name: dynamicScopeId
required: true
description: The dynamicScopeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/electronicSignatures/auth:
post:
operationId: core_ElectronicSignatureResource_checkAuth
tags:
- Electronic Signatures
summary: Check auth
description: Check auth
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/electronicSignatures/meanings:
get:
operationId: core_ElectronicSignatureResource_getMeanings
tags:
- Electronic Signatures
summary: Gets all of the configured electronic signature meanings
description: Gets all of the configured electronic signature meanings
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: core_ElectronicSignatureResource_createMeaning
tags:
- Electronic Signatures
summary: Create meaning
description: Create meaning
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/electronicSignatures/meanings/{name}':
get:
operationId: core_ElectronicSignatureResource_getMeaning
tags:
- Electronic Signatures
summary: Get the localized meaning for a given Signature type
description: Get the localized meaning for a given Signature type
parameters:
- in: path
name: name
required: true
description: The name.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
object:
type: object
description: The returned object
example: {"object": {"id": "abc-12345", "name": "Example Item"}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
put:
operationId: core_ElectronicSignatureResource_updateMeaning
tags:
- Electronic Signatures
summary: Update meaning
description: Update meaning
parameters:
- in: path
name: name
required: true
description: The name.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
delete:
operationId: core_ElectronicSignatureResource_deleteMeaning
tags:
- Electronic Signatures
summary: Deletes the specified meaning
description: Deletes the specified meaning
parameters:
- in: path
name: name
required: true
description: The name.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/exceptions:
get:
operationId: core_ExceptionsResource_getExceptions
tags:
- IIQ
summary: 'Return the exceptions on the identity, optionally filtering by application and instance'
description: 'Return the exceptions on the identity, optionally filtering by application and instance'
parameters:
- in: query
name: application
required: false
description: The application query parameter.
schema:
type: string
- in: query
name: instance
required: false
description: The instance query parameter.
schema:
type: string
- in: query
name: excludePermissions
required: false
description: The excludePermissions query parameter.
schema:
type: boolean
- in: query
name: showEntitlementDescriptions
required: false
description: The showEntitlementDescriptions query parameter.
schema:
type: boolean
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/exclusions:
get:
operationId: core_ExclusionsListResource_list
tags:
- Policy
summary: Return a list of exclusions
description: Return a list of exclusions
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/exists:
get:
operationId: core_WorkflowResource_exists
tags:
- Workflows
summary: 'Tests the existence of a workflow resource, and is used in the BPE to test for workflow name uniqueness before using ''save as'' functionality'
description: 'Tests the existence of a workflow resource, and is used in the BPE to test for workflow name uniqueness before using ''save as'' functionality'
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/export/status:
get:
operationId: core_ExportResource_getStatus
tags:
- Export
summary: Return the status from the currently running export (PDF or CSV)
description: Return the status from the currently running export (PDF or CSV)
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"percentComplete": "example-percentComplete", "status": "Active"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/form:
post:
operationId: core_FormResource_createForm
tags:
- Forms
summary: 'Create a form of type Application, Role and Workflow'
description: 'Create a form of type Application, Role and Workflow'
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/form/buttons:
post:
operationId: core_FormResource_getButtons
tags:
- Forms
summary: Get buttons
description: Get buttons
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/form/formTypes:
get:
operationId: core_FormResource_getFormTypes
tags:
- Forms
summary: Get the Form Types
description: Get the Form Types
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/form/preview:
post:
operationId: core_FormResource_getPreviewForm
tags:
- Forms
summary: Return a FormDTO for preview form
description: Return a FormDTO for preview form
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/form/{formId}':
get:
operationId: core_FormResource_getForm
tags:
- Forms
summary: 'Retrieve the Form by ID from database, form an equivalent JSON and return it'
description: 'Retrieve the Form by ID from database, form an equivalent JSON and return it'
parameters:
- in: path
name: formId
required: true
description: The formId.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: string
example: "example-value"
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
put:
operationId: core_FormResource_updateForm
tags:
- Forms
summary: 'Updates a form of type Application, Role and Workflow'
description: 'Updates a form of type Application, Role and Workflow'
parameters:
- in: path
name: formId
required: true
description: The formId.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/forms:
get:
operationId: core_FormListResource_list
tags:
- Forms
summary: Get forms from the database
description: Get forms from the database
parameters:
- in: query
name: type
required: false
description: The type query parameter.
schema:
type: string
- in: query
name: name
required: false
description: The name query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/forward:
post:
operationId: core_CertificationGroupResource_forward_2
tags:
- Certification Groups
summary: Forward
description: Forward
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/groupFactory/list:
get:
operationId: core_GroupFactoryResource_getFactories
tags:
- Groups
summary: Get factories
description: Get factories
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/groupFactory/options:
get:
operationId: core_GroupFactoryResource_getOptions
tags:
- Groups
summary: Get options
description: Get options
parameters:
- in: query
name: id
required: false
description: The id query parameter.
schema:
type: string
- in: query
name: start
required: false
description: The start query parameter.
schema:
type: integer
format: int32
- in: query
name: limit
required: false
description: The limit query parameter.
schema:
type: integer
format: int32
- in: query
name: page
required: false
description: The page query parameter.
schema:
type: integer
format: int32
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/history:
get:
operationId: core_IdentityHistoryResource_getIdentityHistoryItems
tags:
- Identities
summary: 'Return the history items for the identity, filtering as needed'
description: 'Return the history items for the identity, filtering as needed'
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/history/byItem:
get:
operationId: core_IdentityHistoryResource_getIdentityHistoryByItem_2
tags:
- Identities
summary: 'Return the history items for the identity on the given cert item, filtering as needed'
description: 'Return the history items for the identity on the given cert item, filtering as needed'
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/history/item:
get:
operationId: core_IdentityHistoryResource_getIdentityHistoryItem
tags:
- Identities
summary: Return the history item with the given id
description: Return the history item with the given id
parameters:
- in: query
name: id
required: false
description: The id query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"id": "abc-12345", "identityId": "abc-12345", "identityName": "jsmith", "displayName": "John Smith", "itemType": "Role", "itemName": "Example Role", "action": "Added", "startDate": "2024-01-01T00:00:00Z", "endDate": "2024-12-31T23:59:59Z", "actor": "system"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/hosts:
get:
operationId: core_HostsResource_getHosts
tags:
- Hosts
summary: Return a list of the Server objects
description: Return a list of the Server objects
parameters:
- in: query
name: active
required: false
description: The active query parameter.
schema:
type: boolean
- in: query
name: services
required: false
description: The services query parameter.
schema:
type: boolean
- in: query
name: defaults
required: false
description: The defaults query parameter.
schema:
type: boolean
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/hosts/{serverId}':
get:
operationId: core_HostsResource_getServer
tags:
- Hosts
summary: Get server
description: Get server
parameters:
- in: path
name: serverId
required: true
description: The serverId.
schema:
type: string
- in: query
name: services
required: false
description: The services query parameter.
schema:
type: boolean
- in: query
name: defaults
required: false
description: The defaults query parameter.
schema:
type: boolean
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: ServerDTO
example: {"name": "Example Item", "description": "A brief description.", "includedServices": ["example-value"], "excludedServices": ["example-value"], "serviceStates": [{}], "heartbeat": "example-heartbeat", "extendedAttributes": {"key": "value"}, "state": "Active", "cpuUsage": "example-cpuUsage", "requestThreads": "example-requestThreads", "taskThreads": "example-taskThreads", "memoryUsage": "example-memoryUsage", "memoryUsagePercentage": "example-memoryUsagePercentage", "databaseResponseTime": "2024-01-01T00:00:00Z", "openFileCount": 1, "enabledStatistics": ["example-value"], "pollingInterval": 0, "retention": 0, "monitoredApplications": [{"displayName": "Example Display", "name": "Example Item"}], "defaultStatistics": ["example-value"], "defaultPollingInterval": 0, "defaultRetention": 0, "monitoringCfg": {"key": "value"}, "apps": ["example-value"], "appId": "abc-12345", "ops": {"orderings": [{}], "groupBys": ["example-value"], "distinct": true, "ignoreCase": true, "firstRow": 0, "resultLimit": 0, "filters": [{}], "scopeExtensions": [{}], "scopeResults": true, "unscopedGloballyAccessible": true, "query": "example-query", "transactionLock": true, "cacheResults": true, "flushBeforeQuery": true, "cloneResults": true, "dirtyRead": true, "commitOnClone": true, "column": "example-column", "ascending": true, "ordering": {}, "o": {}, "f": {}, "id": "abc-12345", "children": [{}], "v": "example-v", "ownerFilter": {}, "ownerCol": "example-ownerCol", "workgroups": [{}], "owners": [{}], "qo": {}, "sb": {}}, "ids": ["example-value"]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
delete:
operationId: core_HostsResource_deleteServer
tags:
- Hosts
summary: Delete server
description: Delete server
parameters:
- in: path
name: serverId
required: true
description: The serverId.
schema:
type: string
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
put:
operationId: core_HostsResource_updateServer
tags:
- Hosts
summary: Update server
description: Update server
parameters:
- in: path
name: serverId
required: true
description: The serverId.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"ASC": "example-ASC", "enabledStatistics": true, "name": "Example Name", "pollingInterval": "example-pollingInterval", "retention": "example-retention", "sort": "ASC"}
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
patch:
operationId: core_HostsResource_patchServer
tags:
- Hosts
summary: Patch server
description: Patch server
parameters:
- in: path
name: serverId
required: true
description: The serverId.
schema:
type: string
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/identities:
post:
operationId: core_IdentityListResource_createIdentity
tags:
- Identities
summary: Create a new identity with the attributes in the given map
description: Create a new identity with the attributes in the given map
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"id": "abc-12345"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"id": "abc-12345"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/identities/findByAccount:
get:
operationId: core_IdentityListResource_getIdentityNameFilterByLinks
tags:
- Identities
summary: Returns the identity cube name for given Link
description: Returns the identity cube name for given Link
parameters:
- in: query
name: application
required: false
description: The application query parameter.
schema:
type: string
- in: query
name: nativeIdentity
required: false
description: The nativeIdentity query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: string
example: "example-value"
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/identities/grid/filtered:
get:
operationId: core_FilteredIdentityListResource_getFilteredIdentities
tags:
- Identities
summary: Get a list of identities filtered by search params
description: Get a list of identities filtered by search params
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/grid/{identityId}/managedIdentities':
get:
operationId: core_IdentityListResource_getGridManagedIdentities
tags:
- Identities
summary: Return a grid compatible list of identities that the given identity can "manage"
description: Return a grid compatible list of identities that the given identity can "manage"
parameters:
- in: path
name: identityId
required: true
description: The identityId.
schema:
type: string
- in: query
name: name
required: false
description: The name query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/population/{populationId}/groupDefinition':
get:
operationId: core_IdentityListResource_getPopulation
tags:
- Identities
summary: Return a grid compatible list of identities based on the given GroupDefinition id
description: Return a grid compatible list of identities based on the given GroupDefinition id
parameters:
- in: path
name: populationId
required: true
description: The populationId.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}':
get:
operationId: core_IdentityResource_getIdentity
tags:
- Identities
summary: Return a map representation of the given identity
description: Return a map representation of the given identity
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"application": "Example Application", "colKey": "example-colKey", "nativeIdentity": "abc-12345", "roleId": "abc-12345", "showNonMatched": "example-showNonMatched", "teamsUserId": "abc-12345"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
put:
operationId: core_IdentityResource_createOrUpdateIdentity
tags:
- Identities
summary: Create or update the given identity with the attributes in the given map
description: Create or update the given identity with the attributes in the given map
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"application": "Example Application", "colKey": "example-colKey", "nativeIdentity": "abc-12345", "roleId": "abc-12345", "showNonMatched": "example-showNonMatched", "teamsUserId": "abc-12345"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"application": "Example Application", "colKey": "example-colKey", "nativeIdentity": "abc-12345", "roleId": "abc-12345", "showNonMatched": "example-showNonMatched", "teamsUserId": "abc-12345"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: core_IdentityResource_createIdentity_2
tags:
- Identities
summary: Create a new identity with the attributes in the given map
description: Create a new identity with the attributes in the given map
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"application": "Example Application", "colKey": "example-colKey", "nativeIdentity": "abc-12345", "roleId": "abc-12345", "showNonMatched": "example-showNonMatched", "teamsUserId": "abc-12345"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"application": "Example Application", "colKey": "example-colKey", "nativeIdentity": "abc-12345", "roleId": "abc-12345", "showNonMatched": "example-showNonMatched", "teamsUserId": "abc-12345"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/aggregate':
post:
operationId: core_IdentityResource_aggregate_2
tags:
- Identities
summary: Aggregate the given resource object for the given application onto the given identity
description: Aggregate the given resource object for the given application onto the given identity
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"application": "Example Application", "colKey": "example-colKey", "nativeIdentity": "abc-12345", "roleId": "abc-12345", "showNonMatched": "example-showNonMatched", "teamsUserId": "abc-12345"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"application": "Example Application", "colKey": "example-colKey", "nativeIdentity": "abc-12345", "roleId": "abc-12345", "showNonMatched": "example-showNonMatched", "teamsUserId": "abc-12345"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/checkAuthorization':
get:
operationId: core_IdentityResource_checkAuthorization_2
tags:
- Identities
summary: Check whether the request identity has the given right
description: Check whether the request identity has the given right
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"application": "Example Application", "colKey": "example-colKey", "nativeIdentity": "abc-12345", "roleId": "abc-12345", "showNonMatched": "example-showNonMatched", "teamsUserId": "abc-12345"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/exceptions':
get:
operationId: core_ExceptionsResource_getExceptions_2
tags:
- IIQ
summary: 'Return the exceptions on the identity, optionally filtering by application and instance'
description: 'Return the exceptions on the identity, optionally filtering by application and instance'
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
- in: query
name: application
required: false
description: The application query parameter.
schema:
type: string
- in: query
name: instance
required: false
description: The instance query parameter.
schema:
type: string
- in: query
name: excludePermissions
required: false
description: The excludePermissions query parameter.
schema:
type: boolean
- in: query
name: showEntitlementDescriptions
required: false
description: The showEntitlementDescriptions query parameter.
schema:
type: boolean
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/history':
get:
operationId: core_IdentityHistoryResource_getIdentityHistoryItems_2
tags:
- Identities
summary: 'Return the history items for the identity, filtering as needed'
description: 'Return the history items for the identity, filtering as needed'
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/history/byItem':
get:
operationId: core_IdentityHistoryResource_getIdentityHistoryByItem_3
tags:
- Identities
summary: 'Return the history items for the identity on the given cert item, filtering as needed'
description: 'Return the history items for the identity on the given cert item, filtering as needed'
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/history/item':
get:
operationId: core_IdentityHistoryResource_getIdentityHistoryItem_2
tags:
- Identities
summary: Return the history item with the given id
description: Return the history item with the given id
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
- in: query
name: id
required: false
description: The id query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"id": "abc-12345", "identityId": "abc-12345", "identityName": "jsmith", "displayName": "John Smith", "itemType": "Role", "itemName": "Example Role", "action": "Added", "startDate": "2024-01-01T00:00:00Z", "endDate": "2024-12-31T23:59:59Z", "actor": "system"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/identityEntitlementRoles':
get:
operationId: core_IdentityEntitlementRoleResource_getRoleEntitlements
tags:
- Identities
summary: Get a list of roleEntitlementDTOs
description: Get a list of roleEntitlementDTOs
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
- in: query
name: start
required: false
description: The start query parameter.
schema:
type: integer
format: int32
- in: query
name: limit
required: false
description: The limit query parameter.
schema:
type: integer
format: int32
- in: query
name: sort
required: false
description: The sort query parameter.
schema:
type: string
- in: query
name: dir
required: false
description: The dir query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/identityEntitlementRoles/{identityEntitlementId}/details':
get:
operationId: core_RoleDetailResource_getDetails
tags:
- Roles
summary: Get a RoleDetailDTO to represent to current role
description: Get a RoleDetailDTO to represent to current role
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
- in: path
name: identityEntitlementId
required: true
description: The identityEntitlementId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: RoleDetailDTO
example: {"id": "abc-12345", "identityId": "abc-12345", "identityDisplayName": "Example Identitydisplay", "assignmentId": "abc-12345", "identityHasRole": true, "assigned": true, "detected": true, "displayName": "Example Display", "type": "ExampleType", "typeIcon": "example-typeIcon", "owner": {"id": "abc-12345", "name": "Example Item", "displayName": "Example Display"}, "description": "A brief description.", "iiqElevatedAccess": true, "permittedBy": "example-permittedBy", "assignmentNote": "example-assignmentNote", "accountDetails": [{"value": "example-value", "application": "Example Application", "account": 1, "nativeIdentity": "example-nativeIdentity", "sourceRole": "example-sourceRole", "iiqElevatedAccess": true}], "contributingEntitlements": [{"nativeIdentity": "example-nativeIdentity", "accountName": "Example Account", "assigned": true, "grantedByRole": true, "startDate": "2024-01-01T00:00:00Z", "endDate": "2024-01-01T00:00:00Z", "lastCertDate": "2024-01-01T00:00:00Z", "lastCertName": "Example Lastcert", "lastCertificationItem": {}, "pendingCertificationItem": {}, "lastRequestItem": {}, "pendingRequestItem": {}, "assigner": "example-assigner", "source": "example-source", "foundOnAccount": true, "detectedRole": true, "hasPendingRequest": true, "pendingRequestId": "abc-12345", "allowed": true, "entitlementRequireEndDateTime": true, "entitlementMaxAccessTimeEnabled": true, "entitlementMaxAccessTimeValue": 0, "entitlementMaxAccessTimeUnit": "example-entitlementMaxAccessTimeUnit", "sourceAssignableRoleNames": ["example-value"], "sourceDetectableRoleNames": ["example-value"], "lastItem": {}, "pendingItem": {}}], "permittedRoles": [{}], "requiredRoles": [{}], "hierarchy": [{}], "hasHierarchy": true, "classificationNames": ["example-value"], "profiles": [{"name": "Example Item", "application": "Example Application", "iiqElevatedAccess": true, "constraints": ["example-value"], "permissions": [{}], "entitlements": [{}]}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/identityEntitlementRoles/{identityEntitlementId}/details/classifications':
get:
operationId: core_ClassificationListResource_getClassifications_2
tags:
- Managed Attributes
summary: Public GET method to retrieve a ListResult of ClassificationDTOs
description: Public GET method to retrieve a ListResult of ClassificationDTOs
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
- in: path
name: identityEntitlementId
required: true
description: The identityEntitlementId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/identityEntitlementRoles/{identityEntitlementId}/details/simpleEntitlements':
get:
operationId: core_RoleDetailResource_getSimpleEntitlements
tags:
- Roles
summary: Returns a list of simple entitlements on the specified role
description: Returns a list of simple entitlements on the specified role
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
- in: path
name: identityEntitlementId
required: true
description: The identityEntitlementId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/identityEntitlementRoles/{identityEntitlementId}/details/{managedAttributeId}/managedAttributeDetails':
get:
operationId: core_ManagedAttributeDetailResource_getDetails_2
tags:
- Managed Attributes
summary: Get the details for the managed attribute
description: Get the details for the managed attribute
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
- in: path
name: identityEntitlementId
required: true
description: The identityEntitlementId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: ManagedAttributeDetailDTO
example: {"id": "abc-12345", "application": "Example Application", "type": "ExampleType", "attribute": "example-attribute", "value": "example-value", "displayValue": "example-displayValue", "description": "A brief description.", "owner": "jsmith", "requestable": true, "iiqElevatedAccess": true, "extendedAttributes": {"key": "value"}, "groupAttributes": {"key": "value"}, "groupEntitlements": [{"nativeIdentity": "example-nativeIdentity", "accountName": "Example Account", "assigned": true, "grantedByRole": true, "startDate": "2024-01-01T00:00:00Z", "endDate": "2024-01-01T00:00:00Z", "lastCertDate": "2024-01-01T00:00:00Z", "lastCertName": "Example Lastcert", "lastCertificationItem": {}, "pendingCertificationItem": {}, "lastRequestItem": {}, "pendingRequestItem": {}, "assigner": "example-assigner", "source": "example-source", "foundOnAccount": true, "detectedRole": true, "hasPendingRequest": true, "pendingRequestId": "abc-12345", "allowed": true, "entitlementRequireEndDateTime": true, "entitlementMaxAccessTimeEnabled": true, "entitlementMaxAccessTimeValue": 0, "entitlementMaxAccessTimeUnit": "example-entitlementMaxAccessTimeUnit", "sourceAssignableRoleNames": ["example-value"], "sourceDetectableRoleNames": ["example-value"], "lastItem": {}, "pendingItem": {}}], "hasInheritance": true, "hasAccess": true, "hasMembers": true, "hasClassifications": true, "hasCloudAccess": true, "hasRoles": true}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/identityEntitlementRoles/{identityEntitlementId}/details/{managedAttributeId}/managedAttributeDetails/access':
get:
operationId: core_TargetAssociationListResource_getAssociations_2
tags:
- Managed Attributes
summary: Get associations
description: Get associations
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
- in: path
name: identityEntitlementId
required: true
description: The identityEntitlementId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/identityEntitlementRoles/{identityEntitlementId}/details/{managedAttributeId}/managedAttributeDetails/cam/group':
get:
operationId: core_ManagedAttributeDetailResource_getGroup_2
tags:
- Managed Attributes
summary: Gets the sub resource for getting the CAM group details for this managed attribute
description: Gets the sub resource for getting the CAM group details for this managed attribute
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
- in: path
name: identityEntitlementId
required: true
description: The identityEntitlementId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: CAMGroupDTO
example: {"errors": ["example-value"], "roles": [{"nativeId": "abc-12345", "cspType": "ExampleType", "displayName": "Example Display", "uri": "https://example.sailpoint.com", "adminCount": 1, "writeCount": 1, "readCount": 1, "scopes": [{}], "errors": ["example-value"], "camScopeDTO": {}}], "services": [{"name": "Example Item", "type": "ExampleType", "numResources": 0}], "uri": "https://example.sailpoint.com", "cspType": "ExampleType", "nativeId": "abc-12345", "displayName": "Example Display", "rolesList": {"items": [{}], "federatedRolesList": {}, "sb": {}}, "servicesList": {"items": [{}], "servicesList": {}, "sb": {}}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/identityEntitlementRoles/{identityEntitlementId}/details/{managedAttributeId}/managedAttributeDetails/cam/scope':
get:
operationId: core_ManagedAttributeDetailResource_getScopeServices_2
tags:
- Managed Attributes
summary: Gets the sub resource for getting the CAM details for this managed attribute
description: Gets the sub resource for getting the CAM details for this managed attribute
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
- in: path
name: identityEntitlementId
required: true
description: The identityEntitlementId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
- in: query
name: uri
required: false
description: The uri query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/identityEntitlementRoles/{identityEntitlementId}/details/{managedAttributeId}/managedAttributeDetails/cam/service':
get:
operationId: core_CAMResourcesListResource_getServiceResources_2
tags:
- UI CAM
summary: Get the list of CAM resources
description: Get the list of CAM resources
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
- in: path
name: identityEntitlementId
required: true
description: The identityEntitlementId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/identityEntitlementRoles/{identityEntitlementId}/details/{managedAttributeId}/managedAttributeDetails/classifications':
get:
operationId: core_ClassificationListResource_getClassifications_3
tags:
- Managed Attributes
summary: Public GET method to retrieve a ListResult of ClassificationDTOs
description: Public GET method to retrieve a ListResult of ClassificationDTOs
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
- in: path
name: identityEntitlementId
required: true
description: The identityEntitlementId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/identityEntitlementRoles/{identityEntitlementId}/details/{managedAttributeId}/managedAttributeDetails/inheritance/children':
get:
operationId: core_ManagedAttributeInheritanceListResource_getChildren_2
tags:
- Managed Attributes
summary: Gets the children managed attributes based on inheritance
description: Gets the children managed attributes based on inheritance
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
- in: path
name: identityEntitlementId
required: true
description: The identityEntitlementId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/identityEntitlementRoles/{identityEntitlementId}/details/{managedAttributeId}/managedAttributeDetails/inheritance/parents':
get:
operationId: core_ManagedAttributeInheritanceListResource_getParents_2
tags:
- Managed Attributes
summary: Gets the parent managed attributes based on inheritance
description: Gets the parent managed attributes based on inheritance
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
- in: path
name: identityEntitlementId
required: true
description: The identityEntitlementId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/identityEntitlementRoles/{identityEntitlementId}/details/{managedAttributeId}/managedAttributeDetails/members':
get:
operationId: core_AccountGroupMemberListResource_getMembers_2
tags:
- Account Groups
summary: Get the list of account group members
description: Get the list of account group members
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
- in: path
name: identityEntitlementId
required: true
description: The identityEntitlementId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/identityEntitlementRoles/{identityEntitlementId}/details/{managedAttributeId}/managedAttributeDetails/roles':
get:
operationId: core_AccountGroupRolesListResource_getRoles_2
tags:
- Account Groups
summary: Get the list of associated roles for ManagedAttribute
description: Get the list of associated roles for ManagedAttribute
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
- in: path
name: identityEntitlementId
required: true
description: The identityEntitlementId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/identityEntitlementRoles/{identityEntitlementId}/details/{subRoleId}/hierarchy':
get:
operationId: core_RoleDetailResource_getHierarchy
tags:
- Roles
summary: Get a list of RoleDetailDTOs to represent the next level of hierarchy for the given sub role
description: Get a list of RoleDetailDTOs to represent the next level of hierarchy for the given sub role
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
- in: path
name: identityEntitlementId
required: true
description: The identityEntitlementId path parameter.
schema:
type: string
- in: path
name: subRoleId
required: true
description: The subRoleId.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: array
items:
type: object
example: [{"id": "12345", "name": "Example Item", "description": "Sample record"}]
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/identityEntitlementRoles/{roleId}/classifications':
get:
operationId: core_ClassificationListResource_getClassifications_4
tags:
- Managed Attributes
summary: Public GET method to retrieve a ListResult of ClassificationDTOs
description: Public GET method to retrieve a ListResult of ClassificationDTOs
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
- in: path
name: roleId
required: true
description: The roleId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/identityEntitlements':
get:
operationId: core_IdentityEntitlementResource_getEntitlements
tags:
- Identities
summary: List method that was initially designed to be called from the Entitlements grid listed on the Identity page
description: List method that was initially designed to be called from the Entitlements grid listed on the Identity page
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
- in: query
name: start
required: false
description: The start query parameter.
schema:
type: integer
format: int32
- in: query
name: limit
required: false
description: The limit query parameter.
schema:
type: integer
format: int32
- in: query
name: sort
required: false
description: The sort query parameter.
schema:
type: string
- in: query
name: dir
required: false
description: The dir query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/identityEntitlements/{entitlementId}':
get:
operationId: core_IdentityEntitlementResource_getEntitlementDTO
tags:
- Identities
summary: Build an entitlement dto out of the given entitlement id
description: Build an entitlement dto out of the given entitlement id
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
- in: path
name: entitlementId
required: true
description: The entitlementId.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: IdentityEntitlementDTO
example: {"nativeIdentity": "example-nativeIdentity", "accountName": "Example Account", "assigned": true, "grantedByRole": true, "startDate": "2024-01-01T00:00:00Z", "endDate": "2024-01-01T00:00:00Z", "lastCertDate": "2024-01-01T00:00:00Z", "lastCertName": "Example Lastcert", "lastCertificationItem": {"displayName": "Example Display", "description": "A brief description.", "certificationStartDate": "2024-01-01T00:00:00Z", "certificationFinishDate": "2024-01-01T00:00:00Z", "certificationMitigationExpirationDate": "2024-01-01T00:00:00Z", "certificationName": "Example Certification", "certifier": "example-certifier", "localizedActionStatus": "Active", "entity": {}, "cert": {}, "certifiers": ["example-value"], "identityService": {}, "certifiersDisplayNames": ["example-value"], "certifierDisplayName": "Example Certifierdisplay", "action": {}, "msg": {}}, "pendingCertificationItem": {"displayName": "Example Display", "description": "A brief description.", "certificationStartDate": "2024-01-01T00:00:00Z", "certificationFinishDate": "2024-01-01T00:00:00Z", "certificationMitigationExpirationDate": "2024-01-01T00:00:00Z", "certificationName": "Example Certification", "certifier": "example-certifier", "localizedActionStatus": "Active", "entity": {}, "cert": {}, "certifiers": ["example-value"], "identityService": {}, "certifiersDisplayNames": ["example-value"], "certifierDisplayName": "Example Certifierdisplay", "action": {}, "msg": {}}, "lastRequestItem": {"name": "Example Item", "requestId": "abc-12345", "trimmedRequestId": "abc-12345", "operation": "example-operation", "source": "example-source", "date": "2024-01-01T00:00:00Z", "requester": "example-requester"}, "pendingRequestItem": {"name": "Example Item", "requestId": "abc-12345", "trimmedRequestId": "abc-12345", "operation": "example-operation", "source": "example-source", "date": "2024-01-01T00:00:00Z", "requester": "example-requester"}, "assigner": "example-assigner", "source": "example-source", "foundOnAccount": true, "detectedRole": true, "hasPendingRequest": true, "pendingRequestId": "abc-12345", "allowed": true, "entitlementRequireEndDateTime": true, "entitlementMaxAccessTimeEnabled": true, "entitlementMaxAccessTimeValue": 0, "entitlementMaxAccessTimeUnit": "example-entitlementMaxAccessTimeUnit", "sourceAssignableRoleNames": ["example-value"], "sourceDetectableRoleNames": ["example-value"], "lastItem": {"messageKey": "example-messageKey", "shortMessageKey": "example-shortMessageKey", "objectConfig": {}, "exceptionApplication": "Example Application", "exceptionAttributeName": "Example Exceptionattribute", "exceptionAttributeValue": "example-exceptionAttributeValue", "exceptionPermissionTarget": "example-exceptionPermissionTarget", "exceptionPermissionRight": "example-exceptionPermissionRight", "finishedDate": "2024-01-01T00:00:00Z", "parent": {}, "challenge": {}, "wakeUpDate": "2024-01-01T00:00:00Z", "phase": {}, "nextPhaseTransition": "example-nextPhaseTransition", "type": {}, "bundle": "example-bundle", "bundleAssignmentId": "abc-12345", "subType": {}, "bundleEntitlements": [{}], "exceptionEntitlements": {}, "violation": {}, "violationSummary": "example-violationSummary", "applicationNames": ["example-value"], "recommendValue": "example-recommendValue", "attributes": {"key": "value"}, "classificationNames": ["example-value"], "iiqElevatedAccess": true, "apps": [{}], "app": {}, "appNames": ["example-value"], "ents": {}, "attrs": {"key": "value"}, "perm": {}, "perms": [{}], "attr": "example-attr", "val": "example-val", "target": "example-target", "right": "example-right", "rights": ["example-value"], "names": ["example-value"], "b": {}, "snap": {}, "config": {}, "att": {}, "attrName": "Example Attr", "autoDecisionFlag": true, "relevantApps": [{}], "role": {}, "item": {}, "exents": {}, "list": [{}], "desc": {}, "es": {}, "identifier": "example-identifier", "parentDel": {}, "status": {}, "completed": "example-completed", "bundleDiffs": {}, "newBundles": ["example-value"], "assignedRoleDiffs": {}, "policyDiff": {}, "newViolations": ["example-value"], "appName": "Example App", "nativeIdentity": "example-nativeIdentity", "newVals": ["example-value"], "extraAttrVals": {}, "extraRights": {}, "isValNewMap": {"key": "value"}, "currRights": ["example-value"], "stateConfig": {}, "owner": {}, "workItem": {}, "certifiers": ["example-value"], "notApproved": [{}], "action": {}, "cert": {}, "otherItems": [{}], "error": "example-error", "ops": {}, "sourceItems": [{}], "identity": {}, "profileId": "abc-12345", "otherProfileId": "abc-12345", "bundleId": "abc-12345", "otherBundleId": "abc-12345", "entityName": "Example Entity", "otherEntityName": "Example Otherentity", "e1": {}, "e2": {}, "e1Instance": "example-e1Instance", "e2Instance": "example-e2Instance", "e1Attr": "example-e1Attr", "e2Attr": "example-e2Attr", "e1Val": "example-e1Val", "e2Val": "example-e2Val", "n1": "example-n1", "n2": "example-n2", "p1": {}, "p2": {}, "attrNames": ["example-value"], "snapshot": {}, "idSnap": {}, "builder": {}, "defaultRemediator": {}, "assignedRole": {}, "assignment": {}, "detectedRole": {}, "systemRevoker": "example-systemRevoker", "relevantLinks": [{}], "appSnapshots": [{}], "bundlesToCheck": [{}], "bundles": ["example-value"], "roles": ["example-value"], "additionalRevokes": ["example-value"], "SortComparator": {}, "collator": {}, "key": "example-key"}, "pendingItem": {"messageKey": "example-messageKey", "shortMessageKey": "example-shortMessageKey", "objectConfig": {}, "exceptionApplication": "Example Application", "exceptionAttributeName": "Example Exceptionattribute", "exceptionAttributeValue": "example-exceptionAttributeValue", "exceptionPermissionTarget": "example-exceptionPermissionTarget", "exceptionPermissionRight": "example-exceptionPermissionRight", "finishedDate": "2024-01-01T00:00:00Z", "parent": {}, "challenge": {}, "wakeUpDate": "2024-01-01T00:00:00Z", "phase": {}, "nextPhaseTransition": "example-nextPhaseTransition", "type": {}, "bundle": "example-bundle", "bundleAssignmentId": "abc-12345", "subType": {}, "bundleEntitlements": [{}], "exceptionEntitlements": {}, "violation": {}, "violationSummary": "example-violationSummary", "applicationNames": ["example-value"], "recommendValue": "example-recommendValue", "attributes": {"key": "value"}, "classificationNames": ["example-value"], "iiqElevatedAccess": true, "apps": [{}], "app": {}, "appNames": ["example-value"], "ents": {}, "attrs": {"key": "value"}, "perm": {}, "perms": [{}], "attr": "example-attr", "val": "example-val", "target": "example-target", "right": "example-right", "rights": ["example-value"], "names": ["example-value"], "b": {}, "snap": {}, "config": {}, "att": {}, "attrName": "Example Attr", "autoDecisionFlag": true, "relevantApps": [{}], "role": {}, "item": {}, "exents": {}, "list": [{}], "desc": {}, "es": {}, "identifier": "example-identifier", "parentDel": {}, "status": {}, "completed": "example-completed", "bundleDiffs": {}, "newBundles": ["example-value"], "assignedRoleDiffs": {}, "policyDiff": {}, "newViolations": ["example-value"], "appName": "Example App", "nativeIdentity": "example-nativeIdentity", "newVals": ["example-value"], "extraAttrVals": {}, "extraRights": {}, "isValNewMap": {"key": "value"}, "currRights": ["example-value"], "stateConfig": {}, "owner": {}, "workItem": {}, "certifiers": ["example-value"], "notApproved": [{}], "action": {}, "cert": {}, "otherItems": [{}], "error": "example-error", "ops": {}, "sourceItems": [{}], "identity": {}, "profileId": "abc-12345", "otherProfileId": "abc-12345", "bundleId": "abc-12345", "otherBundleId": "abc-12345", "entityName": "Example Entity", "otherEntityName": "Example Otherentity", "e1": {}, "e2": {}, "e1Instance": "example-e1Instance", "e2Instance": "example-e2Instance", "e1Attr": "example-e1Attr", "e2Attr": "example-e2Attr", "e1Val": "example-e1Val", "e2Val": "example-e2Val", "n1": "example-n1", "n2": "example-n2", "p1": {}, "p2": {}, "attrNames": ["example-value"], "snapshot": {}, "idSnap": {}, "builder": {}, "defaultRemediator": {}, "assignedRole": {}, "assignment": {}, "detectedRole": {}, "systemRevoker": "example-systemRevoker", "relevantLinks": [{}], "appSnapshots": [{}], "bundlesToCheck": [{}], "bundles": ["example-value"], "roles": ["example-value"], "additionalRevokes": ["example-value"], "SortComparator": {}, "collator": {}, "key": "example-key"}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/identityEntitlements/{entitlementId}/details':
get:
operationId: core_ManagedAttributeDetailResource_getDetails_3
tags:
- Managed Attributes
summary: Get the details for the managed attribute
description: Get the details for the managed attribute
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
- in: path
name: entitlementId
required: true
description: The entitlementId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: ManagedAttributeDetailDTO
example: {"id": "abc-12345", "application": "Example Application", "type": "ExampleType", "attribute": "example-attribute", "value": "example-value", "displayValue": "example-displayValue", "description": "A brief description.", "owner": "jsmith", "requestable": true, "iiqElevatedAccess": true, "extendedAttributes": {"key": "value"}, "groupAttributes": {"key": "value"}, "groupEntitlements": [{"nativeIdentity": "example-nativeIdentity", "accountName": "Example Account", "assigned": true, "grantedByRole": true, "startDate": "2024-01-01T00:00:00Z", "endDate": "2024-01-01T00:00:00Z", "lastCertDate": "2024-01-01T00:00:00Z", "lastCertName": "Example Lastcert", "lastCertificationItem": {}, "pendingCertificationItem": {}, "lastRequestItem": {}, "pendingRequestItem": {}, "assigner": "example-assigner", "source": "example-source", "foundOnAccount": true, "detectedRole": true, "hasPendingRequest": true, "pendingRequestId": "abc-12345", "allowed": true, "entitlementRequireEndDateTime": true, "entitlementMaxAccessTimeEnabled": true, "entitlementMaxAccessTimeValue": 0, "entitlementMaxAccessTimeUnit": "example-entitlementMaxAccessTimeUnit", "sourceAssignableRoleNames": ["example-value"], "sourceDetectableRoleNames": ["example-value"], "lastItem": {}, "pendingItem": {}}], "hasInheritance": true, "hasAccess": true, "hasMembers": true, "hasClassifications": true, "hasCloudAccess": true, "hasRoles": true}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/identityEntitlements/{entitlementId}/details/access':
get:
operationId: core_TargetAssociationListResource_getAssociations_3
tags:
- Managed Attributes
summary: Get associations
description: Get associations
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
- in: path
name: entitlementId
required: true
description: The entitlementId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/identityEntitlements/{entitlementId}/details/cam/group':
get:
operationId: core_ManagedAttributeDetailResource_getGroup_3
tags:
- Managed Attributes
summary: Gets the sub resource for getting the CAM group details for this managed attribute
description: Gets the sub resource for getting the CAM group details for this managed attribute
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
- in: path
name: entitlementId
required: true
description: The entitlementId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: CAMGroupDTO
example: {"errors": ["example-value"], "roles": [{"nativeId": "abc-12345", "cspType": "ExampleType", "displayName": "Example Display", "uri": "https://example.sailpoint.com", "adminCount": 1, "writeCount": 1, "readCount": 1, "scopes": [{}], "errors": ["example-value"], "camScopeDTO": {}}], "services": [{"name": "Example Item", "type": "ExampleType", "numResources": 0}], "uri": "https://example.sailpoint.com", "cspType": "ExampleType", "nativeId": "abc-12345", "displayName": "Example Display", "rolesList": {"items": [{}], "federatedRolesList": {}, "sb": {}}, "servicesList": {"items": [{}], "servicesList": {}, "sb": {}}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/identityEntitlements/{entitlementId}/details/cam/scope':
get:
operationId: core_ManagedAttributeDetailResource_getScopeServices_3
tags:
- Managed Attributes
summary: Gets the sub resource for getting the CAM details for this managed attribute
description: Gets the sub resource for getting the CAM details for this managed attribute
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
- in: path
name: entitlementId
required: true
description: The entitlementId path parameter.
schema:
type: string
- in: query
name: uri
required: false
description: The uri query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/identityEntitlements/{entitlementId}/details/cam/service':
get:
operationId: core_CAMResourcesListResource_getServiceResources_3
tags:
- UI CAM
summary: Get the list of CAM resources
description: Get the list of CAM resources
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
- in: path
name: entitlementId
required: true
description: The entitlementId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/identityEntitlements/{entitlementId}/details/classifications':
get:
operationId: core_ClassificationListResource_getClassifications_5
tags:
- Managed Attributes
summary: Public GET method to retrieve a ListResult of ClassificationDTOs
description: Public GET method to retrieve a ListResult of ClassificationDTOs
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
- in: path
name: entitlementId
required: true
description: The entitlementId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/identityEntitlements/{entitlementId}/details/inheritance/children':
get:
operationId: core_ManagedAttributeInheritanceListResource_getChildren_3
tags:
- Managed Attributes
summary: Gets the children managed attributes based on inheritance
description: Gets the children managed attributes based on inheritance
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
- in: path
name: entitlementId
required: true
description: The entitlementId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/identityEntitlements/{entitlementId}/details/inheritance/parents':
get:
operationId: core_ManagedAttributeInheritanceListResource_getParents_3
tags:
- Managed Attributes
summary: Gets the parent managed attributes based on inheritance
description: Gets the parent managed attributes based on inheritance
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
- in: path
name: entitlementId
required: true
description: The entitlementId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/identityEntitlements/{entitlementId}/details/members':
get:
operationId: core_AccountGroupMemberListResource_getMembers_3
tags:
- Account Groups
summary: Get the list of account group members
description: Get the list of account group members
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
- in: path
name: entitlementId
required: true
description: The entitlementId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/identityEntitlements/{entitlementId}/details/roles':
get:
operationId: core_AccountGroupRolesListResource_getRoles_3
tags:
- Account Groups
summary: Get the list of associated roles for ManagedAttribute
description: Get the list of associated roles for ManagedAttribute
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
- in: path
name: entitlementId
required: true
description: The entitlementId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/identityIndirectAccess':
get:
operationId: core_IdentityEffectiveAccessListResource_getEffectiveAccess
tags:
- Identities
summary: Get effective access
description: Get effective access
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
- in: query
name: appOrValue
required: false
description: The appOrValue query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/lcmDetails':
post:
operationId: core_IdentityResource_getLcmDetails
tags:
- Identities
summary: Gets the details for an identity if the current user is able to make LCM requests for the identity
description: Gets the details for an identity if the current user is able to make LCM requests for the identity
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
- in: query
name: action
required: false
description: The action query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"application": "Example Application", "colKey": "example-colKey", "nativeIdentity": "abc-12345", "roleId": "abc-12345", "showNonMatched": "example-showNonMatched", "teamsUserId": "abc-12345"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/links':
get:
operationId: core_LinksResource_getLinks_2
tags:
- Applications
summary: 'Return the links on the identity, optionally filtering by application and instance'
description: 'Return the links on the identity, optionally filtering by application and instance'
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
- in: query
name: application
required: false
description: The application query parameter.
schema:
type: string
- in: query
name: instance
required: false
description: The instance query parameter.
schema:
type: string
- in: query
name: includeLinkState
required: false
description: The includeLinkState query parameter.
schema:
type: boolean
- in: query
name: action
required: false
description: The action query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/links/accountsGrid':
get:
operationId: core_LinksResource_getApplicationAccountsGrid_2
tags:
- Applications
summary: Return a list result that contains the accounts on this application
description: Return a list result that contains the accounts on this application
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
- in: query
name: query
required: false
description: The query query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/links/accountsGrid/{linkId}':
get:
operationId: core_LinksResource_getApplicationAccountsGridForLinkId_2
tags:
- Applications
summary: Return a list result that contains the link details for an account in an application
description: Return a list result that contains the link details for an account in an application
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
- in: path
name: linkId
required: true
description: The linkId.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/links/manageAccountsGrid':
get:
operationId: core_LinksResource_getManageAccountsGrid_2
tags:
- Applications
summary: Return a grid compatible list of links that belong to the given identity
description: Return a grid compatible list of links that belong to the given identity
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/links/managePasswordsGrid':
get:
operationId: core_LinksResource_getManagePasswordsGrid_2
tags:
- Applications
summary: Return a grid compatible list of links that belong to the given identity
description: Return a grid compatible list of links that belong to the given identity
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/managedIdentities':
get:
operationId: core_IdentityListResource_getIdentities
tags:
- Identities
summary: Return a list of identities that the given identity can "manage"
description: Return a list of identities that the given identity can "manage"
parameters:
- in: path
name: identityId
required: true
description: The identityId.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: array
items:
type: object
example: [{"id": "12345", "name": "Example Item", "description": "Sample record"}]
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/remoteLogin':
post:
operationId: core_IdentityResource_createRemoteLogin
tags:
- Identities
summary: 'Remote service to allow creating of remote login tokens to allow psuedo-sso for integrations that want to launch into our app given some user context'
description: 'Remote service to allow creating of remote login tokens to allow psuedo-sso for integrations that want to launch into our app given some user context'
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
description: String
example: "example-value"
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: string
example: "example-value"
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/summary':
get:
operationId: core_IdentityResource_getIdentitySummary
tags:
- Identities
summary: Get identity summary
description: Get identity summary
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: IdentitySummary
example: {"id": "abc-12345", "name": "Example Item", "displayName": "Example Display"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/teams/{tenantId}':
put:
operationId: core_IdentityResource_updateTeamsInfo
tags:
- Identities
summary: Update the Teams info for the Identity
description: Update the Teams info for the Identity
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
- in: path
name: tenantId
required: true
description: The tenantId path parameter.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"application": "Example Application", "colKey": "example-colKey", "nativeIdentity": "abc-12345", "roleId": "abc-12345", "showNonMatched": "example-showNonMatched", "teamsUserId": "abc-12345"}
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/workItemCount':
get:
operationId: core_IdentityListResource_getWorkItemCount
tags:
- Identities
summary: Get work item count
description: Get work item count
parameters:
- in: path
name: identityId
required: true
description: The identityId.
schema:
type: string
- in: query
name: type
required: false
description: The type query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: string
example: "example-value"
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identities/{identityId}/workItemDetails/{workItemId}':
post:
operationId: core_IdentityResource_getWorkItemDetails
tags:
- Identities
summary: 'Gets the details for an identity if the current user is the work item owner, and the specified user is on the work item'
description: 'Gets the details for an identity if the current user is the work item owner, and the specified user is on the work item'
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
- in: path
name: workItemId
required: true
description: The workItemId.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"application": "Example Application", "colKey": "example-colKey", "nativeIdentity": "abc-12345", "roleId": "abc-12345", "showNonMatched": "example-showNonMatched", "teamsUserId": "abc-12345"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/identityEntitlementRoles:
get:
operationId: core_IdentityEntitlementRoleResource_getRoleEntitlements_2
tags:
- Identities
summary: Get a list of roleEntitlementDTOs
description: Get a list of roleEntitlementDTOs
parameters:
- in: query
name: start
required: false
description: The start query parameter.
schema:
type: integer
format: int32
- in: query
name: limit
required: false
description: The limit query parameter.
schema:
type: integer
format: int32
- in: query
name: sort
required: false
description: The sort query parameter.
schema:
type: string
- in: query
name: dir
required: false
description: The dir query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identityEntitlementRoles/{identityEntitlementId}/details':
get:
operationId: core_RoleDetailResource_getDetails_2
tags:
- Roles
summary: Get a RoleDetailDTO to represent to current role
description: Get a RoleDetailDTO to represent to current role
parameters:
- in: path
name: identityEntitlementId
required: true
description: The identityEntitlementId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: RoleDetailDTO
example: {"id": "abc-12345", "identityId": "abc-12345", "identityDisplayName": "Example Identitydisplay", "assignmentId": "abc-12345", "identityHasRole": true, "assigned": true, "detected": true, "displayName": "Example Display", "type": "ExampleType", "typeIcon": "example-typeIcon", "owner": {"id": "abc-12345", "name": "Example Item", "displayName": "Example Display"}, "description": "A brief description.", "iiqElevatedAccess": true, "permittedBy": "example-permittedBy", "assignmentNote": "example-assignmentNote", "accountDetails": [{"value": "example-value", "application": "Example Application", "account": 1, "nativeIdentity": "example-nativeIdentity", "sourceRole": "example-sourceRole", "iiqElevatedAccess": true}], "contributingEntitlements": [{"nativeIdentity": "example-nativeIdentity", "accountName": "Example Account", "assigned": true, "grantedByRole": true, "startDate": "2024-01-01T00:00:00Z", "endDate": "2024-01-01T00:00:00Z", "lastCertDate": "2024-01-01T00:00:00Z", "lastCertName": "Example Lastcert", "lastCertificationItem": {}, "pendingCertificationItem": {}, "lastRequestItem": {}, "pendingRequestItem": {}, "assigner": "example-assigner", "source": "example-source", "foundOnAccount": true, "detectedRole": true, "hasPendingRequest": true, "pendingRequestId": "abc-12345", "allowed": true, "entitlementRequireEndDateTime": true, "entitlementMaxAccessTimeEnabled": true, "entitlementMaxAccessTimeValue": 0, "entitlementMaxAccessTimeUnit": "example-entitlementMaxAccessTimeUnit", "sourceAssignableRoleNames": ["example-value"], "sourceDetectableRoleNames": ["example-value"], "lastItem": {}, "pendingItem": {}}], "permittedRoles": [{}], "requiredRoles": [{}], "hierarchy": [{}], "hasHierarchy": true, "classificationNames": ["example-value"], "profiles": [{"name": "Example Item", "application": "Example Application", "iiqElevatedAccess": true, "constraints": ["example-value"], "permissions": [{}], "entitlements": [{}]}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identityEntitlementRoles/{identityEntitlementId}/details/classifications':
get:
operationId: core_ClassificationListResource_getClassifications_6
tags:
- Managed Attributes
summary: Public GET method to retrieve a ListResult of ClassificationDTOs
description: Public GET method to retrieve a ListResult of ClassificationDTOs
parameters:
- in: path
name: identityEntitlementId
required: true
description: The identityEntitlementId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identityEntitlementRoles/{identityEntitlementId}/details/simpleEntitlements':
get:
operationId: core_RoleDetailResource_getSimpleEntitlements_2
tags:
- Roles
summary: Returns a list of simple entitlements on the specified role
description: Returns a list of simple entitlements on the specified role
parameters:
- in: path
name: identityEntitlementId
required: true
description: The identityEntitlementId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identityEntitlementRoles/{identityEntitlementId}/details/{managedAttributeId}/managedAttributeDetails':
get:
operationId: core_ManagedAttributeDetailResource_getDetails_4
tags:
- Managed Attributes
summary: Get the details for the managed attribute
description: Get the details for the managed attribute
parameters:
- in: path
name: identityEntitlementId
required: true
description: The identityEntitlementId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: ManagedAttributeDetailDTO
example: {"id": "abc-12345", "application": "Example Application", "type": "ExampleType", "attribute": "example-attribute", "value": "example-value", "displayValue": "example-displayValue", "description": "A brief description.", "owner": "jsmith", "requestable": true, "iiqElevatedAccess": true, "extendedAttributes": {"key": "value"}, "groupAttributes": {"key": "value"}, "groupEntitlements": [{"nativeIdentity": "example-nativeIdentity", "accountName": "Example Account", "assigned": true, "grantedByRole": true, "startDate": "2024-01-01T00:00:00Z", "endDate": "2024-01-01T00:00:00Z", "lastCertDate": "2024-01-01T00:00:00Z", "lastCertName": "Example Lastcert", "lastCertificationItem": {}, "pendingCertificationItem": {}, "lastRequestItem": {}, "pendingRequestItem": {}, "assigner": "example-assigner", "source": "example-source", "foundOnAccount": true, "detectedRole": true, "hasPendingRequest": true, "pendingRequestId": "abc-12345", "allowed": true, "entitlementRequireEndDateTime": true, "entitlementMaxAccessTimeEnabled": true, "entitlementMaxAccessTimeValue": 0, "entitlementMaxAccessTimeUnit": "example-entitlementMaxAccessTimeUnit", "sourceAssignableRoleNames": ["example-value"], "sourceDetectableRoleNames": ["example-value"], "lastItem": {}, "pendingItem": {}}], "hasInheritance": true, "hasAccess": true, "hasMembers": true, "hasClassifications": true, "hasCloudAccess": true, "hasRoles": true}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identityEntitlementRoles/{identityEntitlementId}/details/{managedAttributeId}/managedAttributeDetails/access':
get:
operationId: core_TargetAssociationListResource_getAssociations_4
tags:
- Managed Attributes
summary: Get associations
description: Get associations
parameters:
- in: path
name: identityEntitlementId
required: true
description: The identityEntitlementId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identityEntitlementRoles/{identityEntitlementId}/details/{managedAttributeId}/managedAttributeDetails/cam/group':
get:
operationId: core_ManagedAttributeDetailResource_getGroup_4
tags:
- Managed Attributes
summary: Gets the sub resource for getting the CAM group details for this managed attribute
description: Gets the sub resource for getting the CAM group details for this managed attribute
parameters:
- in: path
name: identityEntitlementId
required: true
description: The identityEntitlementId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: CAMGroupDTO
example: {"errors": ["example-value"], "roles": [{"nativeId": "abc-12345", "cspType": "ExampleType", "displayName": "Example Display", "uri": "https://example.sailpoint.com", "adminCount": 1, "writeCount": 1, "readCount": 1, "scopes": [{}], "errors": ["example-value"], "camScopeDTO": {}}], "services": [{"name": "Example Item", "type": "ExampleType", "numResources": 0}], "uri": "https://example.sailpoint.com", "cspType": "ExampleType", "nativeId": "abc-12345", "displayName": "Example Display", "rolesList": {"items": [{}], "federatedRolesList": {}, "sb": {}}, "servicesList": {"items": [{}], "servicesList": {}, "sb": {}}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identityEntitlementRoles/{identityEntitlementId}/details/{managedAttributeId}/managedAttributeDetails/cam/scope':
get:
operationId: core_ManagedAttributeDetailResource_getScopeServices_4
tags:
- Managed Attributes
summary: Gets the sub resource for getting the CAM details for this managed attribute
description: Gets the sub resource for getting the CAM details for this managed attribute
parameters:
- in: path
name: identityEntitlementId
required: true
description: The identityEntitlementId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
- in: query
name: uri
required: false
description: The uri query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identityEntitlementRoles/{identityEntitlementId}/details/{managedAttributeId}/managedAttributeDetails/cam/service':
get:
operationId: core_CAMResourcesListResource_getServiceResources_4
tags:
- UI CAM
summary: Get the list of CAM resources
description: Get the list of CAM resources
parameters:
- in: path
name: identityEntitlementId
required: true
description: The identityEntitlementId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identityEntitlementRoles/{identityEntitlementId}/details/{managedAttributeId}/managedAttributeDetails/classifications':
get:
operationId: core_ClassificationListResource_getClassifications_7
tags:
- Managed Attributes
summary: Public GET method to retrieve a ListResult of ClassificationDTOs
description: Public GET method to retrieve a ListResult of ClassificationDTOs
parameters:
- in: path
name: identityEntitlementId
required: true
description: The identityEntitlementId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identityEntitlementRoles/{identityEntitlementId}/details/{managedAttributeId}/managedAttributeDetails/inheritance/children':
get:
operationId: core_ManagedAttributeInheritanceListResource_getChildren_4
tags:
- Managed Attributes
summary: Gets the children managed attributes based on inheritance
description: Gets the children managed attributes based on inheritance
parameters:
- in: path
name: identityEntitlementId
required: true
description: The identityEntitlementId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identityEntitlementRoles/{identityEntitlementId}/details/{managedAttributeId}/managedAttributeDetails/inheritance/parents':
get:
operationId: core_ManagedAttributeInheritanceListResource_getParents_4
tags:
- Managed Attributes
summary: Gets the parent managed attributes based on inheritance
description: Gets the parent managed attributes based on inheritance
parameters:
- in: path
name: identityEntitlementId
required: true
description: The identityEntitlementId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identityEntitlementRoles/{identityEntitlementId}/details/{managedAttributeId}/managedAttributeDetails/members':
get:
operationId: core_AccountGroupMemberListResource_getMembers_4
tags:
- Account Groups
summary: Get the list of account group members
description: Get the list of account group members
parameters:
- in: path
name: identityEntitlementId
required: true
description: The identityEntitlementId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identityEntitlementRoles/{identityEntitlementId}/details/{managedAttributeId}/managedAttributeDetails/roles':
get:
operationId: core_AccountGroupRolesListResource_getRoles_4
tags:
- Account Groups
summary: Get the list of associated roles for ManagedAttribute
description: Get the list of associated roles for ManagedAttribute
parameters:
- in: path
name: identityEntitlementId
required: true
description: The identityEntitlementId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identityEntitlementRoles/{identityEntitlementId}/details/{subRoleId}/hierarchy':
get:
operationId: core_RoleDetailResource_getHierarchy_2
tags:
- Roles
summary: Get a list of RoleDetailDTOs to represent the next level of hierarchy for the given sub role
description: Get a list of RoleDetailDTOs to represent the next level of hierarchy for the given sub role
parameters:
- in: path
name: identityEntitlementId
required: true
description: The identityEntitlementId path parameter.
schema:
type: string
- in: path
name: subRoleId
required: true
description: The subRoleId.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: array
items:
type: object
example: [{"id": "12345", "name": "Example Item", "description": "Sample record"}]
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identityEntitlementRoles/{roleId}/classifications':
get:
operationId: core_ClassificationListResource_getClassifications_8
tags:
- Managed Attributes
summary: Public GET method to retrieve a ListResult of ClassificationDTOs
description: Public GET method to retrieve a ListResult of ClassificationDTOs
parameters:
- in: path
name: roleId
required: true
description: The roleId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/identityEntitlements:
get:
operationId: core_IdentityEntitlementResource_getEntitlements_2
tags:
- Identities
summary: List method that was initially designed to be called from the Entitlements grid listed on the Identity page
description: List method that was initially designed to be called from the Entitlements grid listed on the Identity page
parameters:
- in: query
name: start
required: false
description: The start query parameter.
schema:
type: integer
format: int32
- in: query
name: limit
required: false
description: The limit query parameter.
schema:
type: integer
format: int32
- in: query
name: sort
required: false
description: The sort query parameter.
schema:
type: string
- in: query
name: dir
required: false
description: The dir query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identityEntitlements/{entitlementId}':
get:
operationId: core_IdentityEntitlementResource_getEntitlementDTO_2
tags:
- Identities
summary: Build an entitlement dto out of the given entitlement id
description: Build an entitlement dto out of the given entitlement id
parameters:
- in: path
name: entitlementId
required: true
description: The entitlementId.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: IdentityEntitlementDTO
example: {"nativeIdentity": "example-nativeIdentity", "accountName": "Example Account", "assigned": true, "grantedByRole": true, "startDate": "2024-01-01T00:00:00Z", "endDate": "2024-01-01T00:00:00Z", "lastCertDate": "2024-01-01T00:00:00Z", "lastCertName": "Example Lastcert", "lastCertificationItem": {"displayName": "Example Display", "description": "A brief description.", "certificationStartDate": "2024-01-01T00:00:00Z", "certificationFinishDate": "2024-01-01T00:00:00Z", "certificationMitigationExpirationDate": "2024-01-01T00:00:00Z", "certificationName": "Example Certification", "certifier": "example-certifier", "localizedActionStatus": "Active", "entity": {}, "cert": {}, "certifiers": ["example-value"], "identityService": {}, "certifiersDisplayNames": ["example-value"], "certifierDisplayName": "Example Certifierdisplay", "action": {}, "msg": {}}, "pendingCertificationItem": {"displayName": "Example Display", "description": "A brief description.", "certificationStartDate": "2024-01-01T00:00:00Z", "certificationFinishDate": "2024-01-01T00:00:00Z", "certificationMitigationExpirationDate": "2024-01-01T00:00:00Z", "certificationName": "Example Certification", "certifier": "example-certifier", "localizedActionStatus": "Active", "entity": {}, "cert": {}, "certifiers": ["example-value"], "identityService": {}, "certifiersDisplayNames": ["example-value"], "certifierDisplayName": "Example Certifierdisplay", "action": {}, "msg": {}}, "lastRequestItem": {"name": "Example Item", "requestId": "abc-12345", "trimmedRequestId": "abc-12345", "operation": "example-operation", "source": "example-source", "date": "2024-01-01T00:00:00Z", "requester": "example-requester"}, "pendingRequestItem": {"name": "Example Item", "requestId": "abc-12345", "trimmedRequestId": "abc-12345", "operation": "example-operation", "source": "example-source", "date": "2024-01-01T00:00:00Z", "requester": "example-requester"}, "assigner": "example-assigner", "source": "example-source", "foundOnAccount": true, "detectedRole": true, "hasPendingRequest": true, "pendingRequestId": "abc-12345", "allowed": true, "entitlementRequireEndDateTime": true, "entitlementMaxAccessTimeEnabled": true, "entitlementMaxAccessTimeValue": 0, "entitlementMaxAccessTimeUnit": "example-entitlementMaxAccessTimeUnit", "sourceAssignableRoleNames": ["example-value"], "sourceDetectableRoleNames": ["example-value"], "lastItem": {"messageKey": "example-messageKey", "shortMessageKey": "example-shortMessageKey", "objectConfig": {}, "exceptionApplication": "Example Application", "exceptionAttributeName": "Example Exceptionattribute", "exceptionAttributeValue": "example-exceptionAttributeValue", "exceptionPermissionTarget": "example-exceptionPermissionTarget", "exceptionPermissionRight": "example-exceptionPermissionRight", "finishedDate": "2024-01-01T00:00:00Z", "parent": {}, "challenge": {}, "wakeUpDate": "2024-01-01T00:00:00Z", "phase": {}, "nextPhaseTransition": "example-nextPhaseTransition", "type": {}, "bundle": "example-bundle", "bundleAssignmentId": "abc-12345", "subType": {}, "bundleEntitlements": [{}], "exceptionEntitlements": {}, "violation": {}, "violationSummary": "example-violationSummary", "applicationNames": ["example-value"], "recommendValue": "example-recommendValue", "attributes": {"key": "value"}, "classificationNames": ["example-value"], "iiqElevatedAccess": true, "apps": [{}], "app": {}, "appNames": ["example-value"], "ents": {}, "attrs": {"key": "value"}, "perm": {}, "perms": [{}], "attr": "example-attr", "val": "example-val", "target": "example-target", "right": "example-right", "rights": ["example-value"], "names": ["example-value"], "b": {}, "snap": {}, "config": {}, "att": {}, "attrName": "Example Attr", "autoDecisionFlag": true, "relevantApps": [{}], "role": {}, "item": {}, "exents": {}, "list": [{}], "desc": {}, "es": {}, "identifier": "example-identifier", "parentDel": {}, "status": {}, "completed": "example-completed", "bundleDiffs": {}, "newBundles": ["example-value"], "assignedRoleDiffs": {}, "policyDiff": {}, "newViolations": ["example-value"], "appName": "Example App", "nativeIdentity": "example-nativeIdentity", "newVals": ["example-value"], "extraAttrVals": {}, "extraRights": {}, "isValNewMap": {"key": "value"}, "currRights": ["example-value"], "stateConfig": {}, "owner": {}, "workItem": {}, "certifiers": ["example-value"], "notApproved": [{}], "action": {}, "cert": {}, "otherItems": [{}], "error": "example-error", "ops": {}, "sourceItems": [{}], "identity": {}, "profileId": "abc-12345", "otherProfileId": "abc-12345", "bundleId": "abc-12345", "otherBundleId": "abc-12345", "entityName": "Example Entity", "otherEntityName": "Example Otherentity", "e1": {}, "e2": {}, "e1Instance": "example-e1Instance", "e2Instance": "example-e2Instance", "e1Attr": "example-e1Attr", "e2Attr": "example-e2Attr", "e1Val": "example-e1Val", "e2Val": "example-e2Val", "n1": "example-n1", "n2": "example-n2", "p1": {}, "p2": {}, "attrNames": ["example-value"], "snapshot": {}, "idSnap": {}, "builder": {}, "defaultRemediator": {}, "assignedRole": {}, "assignment": {}, "detectedRole": {}, "systemRevoker": "example-systemRevoker", "relevantLinks": [{}], "appSnapshots": [{}], "bundlesToCheck": [{}], "bundles": ["example-value"], "roles": ["example-value"], "additionalRevokes": ["example-value"], "SortComparator": {}, "collator": {}, "key": "example-key"}, "pendingItem": {"messageKey": "example-messageKey", "shortMessageKey": "example-shortMessageKey", "objectConfig": {}, "exceptionApplication": "Example Application", "exceptionAttributeName": "Example Exceptionattribute", "exceptionAttributeValue": "example-exceptionAttributeValue", "exceptionPermissionTarget": "example-exceptionPermissionTarget", "exceptionPermissionRight": "example-exceptionPermissionRight", "finishedDate": "2024-01-01T00:00:00Z", "parent": {}, "challenge": {}, "wakeUpDate": "2024-01-01T00:00:00Z", "phase": {}, "nextPhaseTransition": "example-nextPhaseTransition", "type": {}, "bundle": "example-bundle", "bundleAssignmentId": "abc-12345", "subType": {}, "bundleEntitlements": [{}], "exceptionEntitlements": {}, "violation": {}, "violationSummary": "example-violationSummary", "applicationNames": ["example-value"], "recommendValue": "example-recommendValue", "attributes": {"key": "value"}, "classificationNames": ["example-value"], "iiqElevatedAccess": true, "apps": [{}], "app": {}, "appNames": ["example-value"], "ents": {}, "attrs": {"key": "value"}, "perm": {}, "perms": [{}], "attr": "example-attr", "val": "example-val", "target": "example-target", "right": "example-right", "rights": ["example-value"], "names": ["example-value"], "b": {}, "snap": {}, "config": {}, "att": {}, "attrName": "Example Attr", "autoDecisionFlag": true, "relevantApps": [{}], "role": {}, "item": {}, "exents": {}, "list": [{}], "desc": {}, "es": {}, "identifier": "example-identifier", "parentDel": {}, "status": {}, "completed": "example-completed", "bundleDiffs": {}, "newBundles": ["example-value"], "assignedRoleDiffs": {}, "policyDiff": {}, "newViolations": ["example-value"], "appName": "Example App", "nativeIdentity": "example-nativeIdentity", "newVals": ["example-value"], "extraAttrVals": {}, "extraRights": {}, "isValNewMap": {"key": "value"}, "currRights": ["example-value"], "stateConfig": {}, "owner": {}, "workItem": {}, "certifiers": ["example-value"], "notApproved": [{}], "action": {}, "cert": {}, "otherItems": [{}], "error": "example-error", "ops": {}, "sourceItems": [{}], "identity": {}, "profileId": "abc-12345", "otherProfileId": "abc-12345", "bundleId": "abc-12345", "otherBundleId": "abc-12345", "entityName": "Example Entity", "otherEntityName": "Example Otherentity", "e1": {}, "e2": {}, "e1Instance": "example-e1Instance", "e2Instance": "example-e2Instance", "e1Attr": "example-e1Attr", "e2Attr": "example-e2Attr", "e1Val": "example-e1Val", "e2Val": "example-e2Val", "n1": "example-n1", "n2": "example-n2", "p1": {}, "p2": {}, "attrNames": ["example-value"], "snapshot": {}, "idSnap": {}, "builder": {}, "defaultRemediator": {}, "assignedRole": {}, "assignment": {}, "detectedRole": {}, "systemRevoker": "example-systemRevoker", "relevantLinks": [{}], "appSnapshots": [{}], "bundlesToCheck": [{}], "bundles": ["example-value"], "roles": ["example-value"], "additionalRevokes": ["example-value"], "SortComparator": {}, "collator": {}, "key": "example-key"}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identityEntitlements/{entitlementId}/details':
get:
operationId: core_ManagedAttributeDetailResource_getDetails_5
tags:
- Managed Attributes
summary: Get the details for the managed attribute
description: Get the details for the managed attribute
parameters:
- in: path
name: entitlementId
required: true
description: The entitlementId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: ManagedAttributeDetailDTO
example: {"id": "abc-12345", "application": "Example Application", "type": "ExampleType", "attribute": "example-attribute", "value": "example-value", "displayValue": "example-displayValue", "description": "A brief description.", "owner": "jsmith", "requestable": true, "iiqElevatedAccess": true, "extendedAttributes": {"key": "value"}, "groupAttributes": {"key": "value"}, "groupEntitlements": [{"nativeIdentity": "example-nativeIdentity", "accountName": "Example Account", "assigned": true, "grantedByRole": true, "startDate": "2024-01-01T00:00:00Z", "endDate": "2024-01-01T00:00:00Z", "lastCertDate": "2024-01-01T00:00:00Z", "lastCertName": "Example Lastcert", "lastCertificationItem": {}, "pendingCertificationItem": {}, "lastRequestItem": {}, "pendingRequestItem": {}, "assigner": "example-assigner", "source": "example-source", "foundOnAccount": true, "detectedRole": true, "hasPendingRequest": true, "pendingRequestId": "abc-12345", "allowed": true, "entitlementRequireEndDateTime": true, "entitlementMaxAccessTimeEnabled": true, "entitlementMaxAccessTimeValue": 0, "entitlementMaxAccessTimeUnit": "example-entitlementMaxAccessTimeUnit", "sourceAssignableRoleNames": ["example-value"], "sourceDetectableRoleNames": ["example-value"], "lastItem": {}, "pendingItem": {}}], "hasInheritance": true, "hasAccess": true, "hasMembers": true, "hasClassifications": true, "hasCloudAccess": true, "hasRoles": true}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identityEntitlements/{entitlementId}/details/access':
get:
operationId: core_TargetAssociationListResource_getAssociations_5
tags:
- Managed Attributes
summary: Get associations
description: Get associations
parameters:
- in: path
name: entitlementId
required: true
description: The entitlementId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identityEntitlements/{entitlementId}/details/cam/group':
get:
operationId: core_ManagedAttributeDetailResource_getGroup_5
tags:
- Managed Attributes
summary: Gets the sub resource for getting the CAM group details for this managed attribute
description: Gets the sub resource for getting the CAM group details for this managed attribute
parameters:
- in: path
name: entitlementId
required: true
description: The entitlementId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: CAMGroupDTO
example: {"errors": ["example-value"], "roles": [{"nativeId": "abc-12345", "cspType": "ExampleType", "displayName": "Example Display", "uri": "https://example.sailpoint.com", "adminCount": 1, "writeCount": 1, "readCount": 1, "scopes": [{}], "errors": ["example-value"], "camScopeDTO": {}}], "services": [{"name": "Example Item", "type": "ExampleType", "numResources": 0}], "uri": "https://example.sailpoint.com", "cspType": "ExampleType", "nativeId": "abc-12345", "displayName": "Example Display", "rolesList": {"items": [{}], "federatedRolesList": {}, "sb": {}}, "servicesList": {"items": [{}], "servicesList": {}, "sb": {}}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identityEntitlements/{entitlementId}/details/cam/scope':
get:
operationId: core_ManagedAttributeDetailResource_getScopeServices_5
tags:
- Managed Attributes
summary: Gets the sub resource for getting the CAM details for this managed attribute
description: Gets the sub resource for getting the CAM details for this managed attribute
parameters:
- in: path
name: entitlementId
required: true
description: The entitlementId path parameter.
schema:
type: string
- in: query
name: uri
required: false
description: The uri query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identityEntitlements/{entitlementId}/details/cam/service':
get:
operationId: core_CAMResourcesListResource_getServiceResources_5
tags:
- UI CAM
summary: Get the list of CAM resources
description: Get the list of CAM resources
parameters:
- in: path
name: entitlementId
required: true
description: The entitlementId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identityEntitlements/{entitlementId}/details/classifications':
get:
operationId: core_ClassificationListResource_getClassifications_9
tags:
- Managed Attributes
summary: Public GET method to retrieve a ListResult of ClassificationDTOs
description: Public GET method to retrieve a ListResult of ClassificationDTOs
parameters:
- in: path
name: entitlementId
required: true
description: The entitlementId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identityEntitlements/{entitlementId}/details/inheritance/children':
get:
operationId: core_ManagedAttributeInheritanceListResource_getChildren_5
tags:
- Managed Attributes
summary: Gets the children managed attributes based on inheritance
description: Gets the children managed attributes based on inheritance
parameters:
- in: path
name: entitlementId
required: true
description: The entitlementId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identityEntitlements/{entitlementId}/details/inheritance/parents':
get:
operationId: core_ManagedAttributeInheritanceListResource_getParents_5
tags:
- Managed Attributes
summary: Gets the parent managed attributes based on inheritance
description: Gets the parent managed attributes based on inheritance
parameters:
- in: path
name: entitlementId
required: true
description: The entitlementId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identityEntitlements/{entitlementId}/details/members':
get:
operationId: core_AccountGroupMemberListResource_getMembers_5
tags:
- Account Groups
summary: Get the list of account group members
description: Get the list of account group members
parameters:
- in: path
name: entitlementId
required: true
description: The entitlementId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/identityEntitlements/{entitlementId}/details/roles':
get:
operationId: core_AccountGroupRolesListResource_getRoles_5
tags:
- Account Groups
summary: Get the list of associated roles for ManagedAttribute
description: Get the list of associated roles for ManagedAttribute
parameters:
- in: path
name: entitlementId
required: true
description: The entitlementId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/identityIndirectAccess:
get:
operationId: core_IdentityEffectiveAccessListResource_getEffectiveAccess_2
tags:
- Identities
summary: Get effective access
description: Get effective access
parameters:
- in: query
name: appOrValue
required: false
description: The appOrValue query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/identityRequests:
post:
operationId: core_IdentityRequestListResource_list
tags:
- Identity Requests
summary: Returns list of task results matching the given query parameters
description: Returns list of task results matching the given query parameters
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/identityRequests/cancelWorkflow:
post:
operationId: core_IdentityRequestListResource_cancelWorkflow
tags:
- Identity Requests
summary: 'Cancels the workflow associated with the task, adding an AuditEvent with the given comments'
description: 'Cancels the workflow associated with the task, adding an AuditEvent with the given comments'
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/image/chart/certification:
get:
operationId: core_ImageResource_getCertification
tags:
- Images
summary: used in the compliance dashboard and certification group page to dynamically generate JFreeChart images
description: used in the compliance dashboard and certification group page to dynamically generate JFreeChart images
parameters:
- in: query
name: id
required: false
description: The id query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/image/chart/dashboard:
get:
operationId: core_ImageResource_getDashboard
tags:
- Images
summary: Get dashboard
description: Get dashboard
parameters:
- in: query
name: id
required: false
description: The id query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/item:
get:
operationId: core_IdentityHistoryResource_getIdentityHistoryItem_3
tags:
- Identities
summary: Return the history item with the given id
description: Return the history item with the given id
parameters:
- in: query
name: id
required: false
description: The id query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"id": "abc-12345", "identityId": "abc-12345", "identityName": "jsmith", "displayName": "John Smith", "itemType": "Role", "itemName": "Example Role", "action": "Added", "startDate": "2024-01-01T00:00:00Z", "endDate": "2024-12-31T23:59:59Z", "actor": "system"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/launch:
post:
operationId: core_WorkflowResource_runWorkflow
tags:
- Workflows
summary: Run a workflow definition with the supplied inputs
description: Run a workflow definition with the supplied inputs
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"workflowArgs": "example-workflowArgs"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/lcmDetails:
post:
operationId: core_IdentityResource_getLcmDetails_2
tags:
- Identities
summary: Gets the details for an identity if the current user is able to make LCM requests for the identity
description: Gets the details for an identity if the current user is able to make LCM requests for the identity
parameters:
- in: query
name: action
required: false
description: The action query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"application": "Example Application", "colKey": "example-colKey", "nativeIdentity": "abc-12345", "roleId": "abc-12345", "showNonMatched": "example-showNonMatched", "teamsUserId": "abc-12345"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/links:
get:
operationId: core_LinksResource_getLinks_3
tags:
- Applications
summary: 'Return the links on the identity, optionally filtering by application and instance'
description: 'Return the links on the identity, optionally filtering by application and instance'
parameters:
- in: query
name: application
required: false
description: The application query parameter.
schema:
type: string
- in: query
name: instance
required: false
description: The instance query parameter.
schema:
type: string
- in: query
name: includeLinkState
required: false
description: The includeLinkState query parameter.
schema:
type: boolean
- in: query
name: action
required: false
description: The action query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/links/accountsGrid:
get:
operationId: core_LinksResource_getApplicationAccountsGrid_3
tags:
- Applications
summary: Return a list result that contains the accounts on this application
description: Return a list result that contains the accounts on this application
parameters:
- in: query
name: query
required: false
description: The query query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/links/accountsGrid/{linkId}':
get:
operationId: core_LinksResource_getApplicationAccountsGridForLinkId_3
tags:
- Applications
summary: Return a list result that contains the link details for an account in an application
description: Return a list result that contains the link details for an account in an application
parameters:
- in: path
name: linkId
required: true
description: The linkId.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/links/manageAccountsGrid:
get:
operationId: core_LinksResource_getManageAccountsGrid_3
tags:
- Applications
summary: Return a grid compatible list of links that belong to the given identity
description: Return a grid compatible list of links that belong to the given identity
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/links/managePasswordsGrid:
get:
operationId: core_LinksResource_getManagePasswordsGrid_3
tags:
- Applications
summary: Return a grid compatible list of links that belong to the given identity
description: Return a grid compatible list of links that belong to the given identity
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/localizedAttribute/languageOptions:
get:
operationId: core_LocalizedAttributeResource_getLocaleOptions
tags:
- Localization
summary: Get locale options
description: Get locale options
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/localizedAttribute/languageSuggest:
get:
operationId: core_LocalizedAttributeResource_getLocaleSuggestOptions
tags:
- Localization
summary: Get locale suggest options
description: Get locale suggest options
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/localizedAttribute/localeNames:
get:
operationId: core_LocalizedAttributeResource_getLocaleNames
tags:
- Localization
summary: Returns a list of locale names from the ObjectConfig
description: Returns a list of locale names from the ObjectConfig
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/managedAttributes:
get:
operationId: core_ManagedAttributesResource_getManagedAttributes
tags:
- Managed Attributes
summary: 'Return a list of the ManagedAttributes, possibly filtered by the available attributes'
description: 'Return a list of the ManagedAttributes, possibly filtered by the available attributes'
parameters:
- in: query
name: value
required: false
description: The value query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/managedAttributes/names:
get:
operationId: core_ManagedAttributesResource_getManagedAttributeNames
tags:
- Managed Attributes
summary: 'A pseudo-resource that returns a list of the names of the ManagedAttributes, possibly filtered by the available attributes'
description: 'A pseudo-resource that returns a list of the names of the ManagedAttributes, possibly filtered by the available attributes'
parameters:
- in: query
name: includeAppNames
required: false
description: The includeAppNames query parameter.
schema:
type: boolean
- in: query
name: excludeNullAttributes
required: false
description: The excludeNullAttributes query parameter.
schema:
type: boolean
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/managedAttributes/spcombo:
post:
operationId: core_ManagedAttributesResource_getManagedAttSuggest
tags:
- Managed Attributes
summary: A resource for fetching the json used in Form Field ComboBox
description: A resource for fetching the json used in Form Field ComboBox
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/managedAttributes/{id}':
get:
operationId: core_ManagedAttributesResource_getManagedAttributeDetails
tags:
- Managed Attributes
summary: Builds of a map containing details of the managed attribute including extended attribute display values
description: Builds of a map containing details of the managed attribute including extended attribute display values
parameters:
- in: path
name: id
required: true
description: The id.
schema:
type: string
- in: query
name: refererType
required: false
description: The refererType query parameter.
schema:
type: string
- in: query
name: refererId
required: false
description: The refererId query parameter.
schema:
type: string
- in: query
name: parentId
required: false
description: The parentId query parameter.
schema:
type: string
- in: query
name: certificationItemId
required: false
description: The certificationItemId query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"application": "Example Application", "attribute": "example-attribute", "description": "Example description", "displayName": "Example Name", "displayValue": "example-displayValue", "displayableName": "Example Name", "extendedAttributes": ["id", "name", "description"], "id": "abc-12345", "iiqElevatedAccess": "example-iiqElevatedAccess", "key": "example-key", "name": "Example Name", "owner": "jsmith", "requestable": "example-requestable", "riskScore": "example-riskScore", "sanitizedDescription": "Example description", "type": "Identity", "value": "example-value"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/managedAttributes/{id}/classifications':
get:
operationId: core_ClassificationListResource_getClassifications_10
tags:
- Managed Attributes
summary: Public GET method to retrieve a ListResult of ClassificationDTOs
description: Public GET method to retrieve a ListResult of ClassificationDTOs
parameters:
- in: path
name: id
required: true
description: The id path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/messageCatalog:
get:
operationId: core_MessageCatalogResource_getLocalizedString_queryParam
tags:
- Messages
summary: Returns the localized version of a catalog entry
description: Returns the localized version of a catalog entry
parameters:
- in: query
name: catKey
required: false
description: The catKey query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: string
example: "example-value"
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/messageCatalog/{catKey}':
get:
operationId: core_MessageCatalogResource_getLocalizedString_pathParam
tags:
- Messages
summary: Returns the localized version of a catalog entry
description: Returns the localized version of a catalog entry
parameters:
- in: path
name: catKey
required: true
description: The catKey.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: string
example: "example-value"
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/metadataValidationCampaigns:
get:
operationId: core_MetadataValidationCampaignListResource_listCampaigns
tags:
- Metadata Validation
summary: 'Returns campaigns visible to the caller with total count and paged {'
description: 'Returns campaigns visible to the caller with total count and paged {'
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"name": "Example Campaign", "description": "A brief description.", "status": "Active", "startDate": "2024-01-01T00:00:00Z", "endDate": "2024-12-31T23:59:59Z"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: core_MetadataValidationCampaignListResource_createCampaign
tags:
- Metadata Validation
summary: 'Starts a metadata validation run for a scoped definition via {'
description: 'Starts a metadata validation run for a scoped definition via {'
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"name": "Example Campaign", "description": "A brief description.", "status": "Active", "startDate": "2024-01-01T00:00:00Z", "endDate": "2024-12-31T23:59:59Z"}
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/metadataValidationCampaigns/{id}':
get:
operationId: core_MetadataValidationCampaignResource_getCampaign
tags:
- Metadata Validation
summary: Returns the full campaign DTO for the path id
description: Returns the full campaign DTO for the path id
parameters:
- in: path
name: id
required: true
description: The id path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"name": "Example Campaign", "description": "A brief description.", "status": "Active"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
put:
operationId: core_MetadataValidationCampaignResource_updateCampaign
tags:
- Metadata Validation
summary: Updates the campaign; request fields are merged — only keys present are applied
description: Updates the campaign; request fields are merged — only keys present are applied
parameters:
- in: path
name: id
required: true
description: The id path parameter.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"name": "Example Campaign", "description": "A brief description.", "status": "Active"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"name": "Example Campaign", "description": "A brief description.", "status": "Active"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
delete:
operationId: core_MetadataValidationCampaignResource_deleteCampaign
tags:
- Metadata Validation
summary: 'Deletes the campaign when allowed for its current status (not active or in-progress generation)'
description: 'Deletes the campaign when allowed for its current status (not active or in-progress generation)'
parameters:
- in: path
name: id
required: true
description: The id path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/metadataValidationCampaigns/{id}/activate':
post:
operationId: core_MetadataValidationCampaignResource_activateCampaign
tags:
- Metadata Validation
summary: 'Activates a Staged campaign: sets status to Active and runs set-level activation hooks (full work-item creation for reviewers is implemented in the work-item layer)'
description: 'Activates a Staged campaign: sets status to Active and runs set-level activation hooks (full work-item creation for reviewers is implemented in the work-item layer)'
parameters:
- in: path
name: id
required: true
description: The id path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"name": "Example Campaign", "description": "A brief description.", "status": "Active"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/metadataValidationCampaigns/{id}/cancel':
post:
operationId: core_MetadataValidationCampaignResource_cancelCampaign
tags:
- Metadata Validation
summary: 'Cancels an Active or Staged campaign by transitioning its status to {'
description: 'Cancels an Active or Staged campaign by transitioning its status to {'
parameters:
- in: path
name: id
required: true
description: The id path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"name": "Example Campaign", "description": "A brief description.", "status": "Active"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/metadataValidationDefinitions:
get:
operationId: core_MetadataValidationDefinitionListResource_listDefinitions
tags:
- Metadata Validation
summary: 'Returns all definitions visible to the caller, with total count and paged items'
description: 'Returns all definitions visible to the caller, with total count and paged items'
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"name": "Example Definition", "description": "A brief description.", "status": "Active", "type": "AttributeValidation"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: core_MetadataValidationDefinitionListResource_createDefinition
tags:
- Metadata Validation
summary: Creates a definition from a JSON object body
description: Creates a definition from a JSON object body
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"name": "Example Definition", "description": "A brief description.", "status": "Active", "type": "AttributeValidation"}
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/metadataValidationDefinitions/config:
get:
operationId: core_MetadataValidationDefinitionListResource_getDefinitionConfig
tags:
- Metadata Validation
summary: 'Returns wizard-oriented configuration for a metadata validation definition type (e'
description: 'Returns wizard-oriented configuration for a metadata validation definition type (e'
parameters:
- in: query
name: type
required: false
description: The type query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"name": "Example Definition", "description": "A brief description.", "status": "Active", "type": "AttributeValidation"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/metadataValidationDefinitions/entitlementMetadataFilters:
get:
operationId: core_MetadataValidationDefinitionListResource_getEntitlementMetadataFilters
tags:
- Metadata Validation
summary: 'List-filter definitions for entitlement (managed-attribute) select criteria, same DTO shape as certification schedule additional-entitlements filters'
description: 'List-filter definitions for entitlement (managed-attribute) select criteria, same DTO shape as certification schedule additional-entitlements filters'
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: array
items:
type: object
example: [{"id": "12345", "name": "Example Item", "description": "Sample record"}]
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/metadataValidationDefinitions/entitlementMetadataFiltersSuggest/suggest/column/{class}/{column}':
post:
operationId: core_SuggestResource_getDistinctColumnSuggest_6
tags:
- Suggest
summary: Get distinct column suggest
description: Get distinct column suggest
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
- in: path
name: column
required: true
description: The column.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/metadataValidationDefinitions/entitlementMetadataFiltersSuggest/suggest/object/{class}':
post:
operationId: core_SuggestResource_getSuggest_6
tags:
- Suggest
summary: Returns a json data feed for a suggest component for the given class type
description: Returns a json data feed for a suggest component for the given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
get:
operationId: core_SuggestResource_simpleList_6
tags:
- Suggest
summary: Simple list
description: Simple list
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/metadataValidationDefinitions/entitlementMetadataFiltersSuggest/suggest/uiconfig:
post:
operationId: core_SuggestResource_getUIConfigSuggest_6
tags:
- Suggest
summary: Get ui config suggest
description: Get ui config suggest
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/metadataValidationDefinitions/roleMetadataFilters:
get:
operationId: core_MetadataValidationDefinitionListResource_getRoleMetadataFilters
tags:
- Metadata Validation
summary: 'List-filter definitions for role (Bundle) select criteria'
description: 'List-filter definitions for role (Bundle) select criteria'
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: array
items:
type: object
example: [{"id": "12345", "name": "Example Item", "description": "Sample record"}]
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/metadataValidationDefinitions/roleMetadataFiltersSuggest/suggest/column/{class}/{column}':
post:
operationId: core_SuggestResource_getDistinctColumnSuggest_7
tags:
- Suggest
summary: Get distinct column suggest
description: Get distinct column suggest
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
- in: path
name: column
required: true
description: The column.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/metadataValidationDefinitions/roleMetadataFiltersSuggest/suggest/object/{class}':
post:
operationId: core_SuggestResource_getSuggest_7
tags:
- Suggest
summary: Returns a json data feed for a suggest component for the given class type
description: Returns a json data feed for a suggest component for the given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
get:
operationId: core_SuggestResource_simpleList_7
tags:
- Suggest
summary: Simple list
description: Simple list
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/metadataValidationDefinitions/roleMetadataFiltersSuggest/suggest/uiconfig:
post:
operationId: core_SuggestResource_getUIConfigSuggest_7
tags:
- Suggest
summary: Get ui config suggest
description: Get ui config suggest
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/metadataValidationDefinitions/roleTypes:
get:
operationId: core_MetadataValidationDefinitionListResource_getRoleTypes
tags:
- Metadata Validation
summary: 'Returns the list of role-type definitions configured in {'
description: 'Returns the list of role-type definitions configured in {'
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: array
items:
type: object
example: [{"id": "12345", "name": "Example Item", "description": "Sample record"}]
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/metadataValidationDefinitions/suggest/suggest/column/{class}/{column}':
post:
operationId: core_SuggestResource_getDistinctColumnSuggest_8
tags:
- Suggest
summary: Get distinct column suggest
description: Get distinct column suggest
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
- in: path
name: column
required: true
description: The column.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/metadataValidationDefinitions/suggest/suggest/object/{class}':
post:
operationId: core_SuggestResource_getSuggest_8
tags:
- Suggest
summary: Returns a json data feed for a suggest component for the given class type
description: Returns a json data feed for a suggest component for the given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
get:
operationId: core_SuggestResource_simpleList_8
tags:
- Suggest
summary: Simple list
description: Simple list
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/metadataValidationDefinitions/suggest/suggest/uiconfig:
post:
operationId: core_SuggestResource_getUIConfigSuggest_8
tags:
- Suggest
summary: Get ui config suggest
description: Get ui config suggest
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/metadataValidationDefinitions/{id}':
get:
operationId: core_MetadataValidationDefinitionResource_getDefinition
tags:
- Metadata Validation
summary: Returns the full definition DTO
description: Returns the full definition DTO
parameters:
- in: path
name: id
required: true
description: The id path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"name": "Example Definition", "description": "A brief description.", "status": "Active", "validationRules": [{"attribute": "email", "rule": "required"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
put:
operationId: core_MetadataValidationDefinitionResource_updateDefinition
tags:
- Metadata Validation
summary: Updates the definition; request body fields are merged—only keys present are applied (partial update)
description: Updates the definition; request body fields are merged—only keys present are applied (partial update)
parameters:
- in: path
name: id
required: true
description: The id path parameter.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"name": "Example Definition", "description": "A brief description.", "status": "Active", "validationRules": [{"attribute": "email", "rule": "required"}]}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"name": "Example Definition", "description": "A brief description.", "status": "Active", "validationRules": [{"attribute": "email", "rule": "required"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
delete:
operationId: core_MetadataValidationDefinitionResource_deleteDefinition
tags:
- Metadata Validation
summary: Deletes the definition
description: Deletes the definition
parameters:
- in: path
name: id
required: true
description: The id path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/metadataValidationDefinitions/{id}/validateAttributesCatalog':
get:
operationId: core_MetadataValidationDefinitionResource_getValidateAttributesCatalog
tags:
- Metadata Validation
summary: 'Returns {'
description: 'Returns {'
parameters:
- in: path
name: id
required: true
description: The id path parameter.
schema:
type: string
- in: query
name: type
required: false
description: The type query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"name": "Example Definition", "description": "A brief description.", "status": "Active", "validationRules": [{"attribute": "email", "rule": "required"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/metadataValidationSets:
get:
operationId: core_MetadataValidationSetListResource_listValidationSets
tags:
- Metadata Validation
summary: Returns metadata validation sets assigned to the logged-in reviewer
description: Returns metadata validation sets assigned to the logged-in reviewer with total count and paged results. Supports pagination via start/limit/offset/firstRow/resultLimit and sorting via sorters (e.g. dueDate:desc or -dueDate).
parameters:
- in: query
name: start
required: false
description: Starting index for pagination.
schema:
type: integer
default: 0
- in: query
name: limit
required: false
description: Maximum number of results to return.
schema:
type: integer
default: 25
- in: query
name: sorters
required: false
description: 'Sort field with optional direction (e.g. dueDate:desc or -dueDate).'
schema:
type: string
- in: query
name: includeSigned
required: false
description: When true, include signed sets alongside unsigned sets.
schema:
type: boolean
default: false
responses:
'200':
description: Returns paged list of metadata validation sets.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of matching validation sets
objects:
type: array
description: List of validation set records
items:
type: object
example:
count: 2
objects:
- setId: "a1b2c3d4e5f6"
shortName: "Q1 Role Metadata Review"
campaignType: "role"
dueDate: "2026-03-31T23:59:59Z"
totalEntities: 50
validatedEntities: 30
totalItems: 200
validatedItems: 120
- setId: "f6e5d4c3b2a1"
shortName: "Entitlement Metadata Review"
campaignType: "entitlement"
dueDate: "2026-06-30T23:59:59Z"
totalEntities: 100
validatedEntities: 0
totalItems: 500
validatedItems: 0
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/metadataValidationSets/{setId}':
get:
operationId: core_MetadataValidationSetListResource_getValidationSet
tags:
- Metadata Validation
summary: Returns a single metadata validation set by ID
description: Returns one metadata validation set in list-row shape for the details page header context. Uses the same field mapping as the list endpoint.
parameters:
- in: path
name: setId
required: true
description: The metadata validation set identifier.
schema:
type: string
responses:
'200':
description: Returns the validation set details.
content:
application/json:
schema:
type: object
example:
setId: "a1b2c3d4e5f6"
shortName: "Q1 Role Metadata Review"
campaignType: "role"
dueDate: "2026-03-31T23:59:59Z"
totalEntities: 50
validatedEntities: 30
totalItems: 200
validatedItems: 120
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/metadataValidationSets/metadataValidationsTab:
get:
operationId: core_MetadataValidationSetListResource_listMetadataValidationsTab
tags:
- Metadata Validation
summary: Returns metadata validations for the Metadata Validations tab
description: Returns metadata validations for the Metadata Validations tab. Accessible to Campaign Administrators (ManageMetadataSets) and Campaign Officers (ManageMetadataCampaign). Supports text filter, definition type, attribute name, reviewer, owner, campaign name, date range, and signed-item filters.
parameters:
- in: query
name: start
required: false
description: Starting index for pagination.
schema:
type: integer
default: 0
- in: query
name: limit
required: false
description: Maximum number of results to return.
schema:
type: integer
default: 25
- in: query
name: filter
required: false
description: Free-text filter for search.
schema:
type: string
- in: query
name: definitionType
required: false
description: Filter by definition type(s).
schema:
type: array
items:
type: string
- in: query
name: attributeName
required: false
description: Filter by attribute name(s).
schema:
type: array
items:
type: string
- in: query
name: reviewerName
required: false
description: Filter by reviewer name.
schema:
type: string
- in: query
name: ownerName
required: false
description: Filter by owner name.
schema:
type: string
- in: query
name: campaignName
required: false
description: Filter by campaign name.
schema:
type: string
- in: query
name: showSignedItem
required: false
description: Whether to include signed items.
schema:
type: boolean
- in: query
name: sorters
required: false
description: 'Sort field with optional direction (e.g. dueDate:desc).'
schema:
type: string
responses:
'200':
description: Returns paged list of metadata validations.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example:
count: 1
objects:
- setId: "a1b2c3d4e5f6"
shortName: "Q1 Role Metadata Review"
campaignType: "role"
reviewerName: "John Smith"
ownerName: "Jane Admin"
dueDate: "2026-03-31T23:59:59Z"
totalEntities: 50
validatedEntities: 30
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/metadataValidationSets/campaign/{campaignId}':
get:
operationId: core_MetadataValidationSetListResource_listCampaignValidations
tags:
- Metadata Validation
summary: Lists the validation sets for a single campaign
description: Returns the validation sets for the View Metadata Validations page of a specific campaign. Requires ListMetavCampaign, ListAllMetavSet, or ViewMetavCampaignSummary rights plus scope authorization.
parameters:
- in: path
name: campaignId
required: true
description: The metadata validation campaign identifier.
schema:
type: string
- in: query
name: start
required: false
description: Starting index for pagination.
schema:
type: integer
default: 0
- in: query
name: limit
required: false
description: Maximum number of results to return.
schema:
type: integer
default: 25
- in: query
name: query
required: false
description: Free-text search query.
schema:
type: string
- in: query
name: reviewerId
required: false
description: Filter by reviewer identity ID.
schema:
type: string
- in: query
name: phase
required: false
description: Filter by campaign phase.
schema:
type: string
- in: query
name: sorters
required: false
description: 'Sort field with optional direction (e.g. dueDate:desc).'
schema:
type: string
responses:
'200':
description: Returns paged list of validation sets for the campaign.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example:
count: 3
objects:
- setId: "a1b2c3d4e5f6"
shortName: "Reviewer 1 Set"
reviewerName: "John Smith"
dueDate: "2026-03-31T23:59:59Z"
totalEntities: 25
validatedEntities: 10
- setId: "b2c3d4e5f6a1"
shortName: "Reviewer 2 Set"
reviewerName: "Jane Doe"
dueDate: "2026-03-31T23:59:59Z"
totalEntities: 25
validatedEntities: 25
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/metadataValidationSet/{set_id}/sign-off':
post:
operationId: core_MetadataValidationSetResource_signOffSet
tags:
- Metadata Validation
summary: Signs off a metadata validation set
description: Signs off a metadata validation set after authorization and validation checks. Returns HTTP 204 No Content on success.
parameters:
- in: path
name: set_id
required: true
description: The metadata validation set identifier.
schema:
type: string
responses:
'204':
description: Sign-off completed successfully. No content returned.
'400':
description: Bad request - validation failed.
'401':
description: Unauthorized.
'403':
description: Forbidden - insufficient rights.
'500':
description: Internal server error.
'/rest/metadataValidationSet/{set_id}/bulk-reassign':
post:
operationId: core_MetadataValidationSetResource_bulkReassign
tags:
- Metadata Validation
summary: Bulk-reassigns entities of a metadata validation set to another reviewer
description: Bulk-reassigns selected entities of a metadata validation set to another reviewer by peeling them into a new or reused child set. The source set is preserved even when emptied so its original reviewer can still sign off.
parameters:
- in: path
name: set_id
required: true
description: The source (parent) metadata validation set identifier.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
required:
- reviewerIdentityId
properties:
reviewerIdentityId:
type: string
description: Target reviewer identity ID for reassignment
entityIds:
type: array
description: List of entity IDs to reassign. Required unless reassignAllEntities is true.
items:
type: string
reassignAllEntities:
type: boolean
description: When true, reassign every entity in the set. entityIds is ignored.
default: false
description:
type: string
description: Optional description for the reassignment
comment:
type: string
description: Optional comment for the reassignment
example:
reviewerIdentityId: "c0a7778b7ef71e79817ee74e6a1f0444"
entityIds:
- "entity-001"
- "entity-002"
- "entity-003"
reassignAllEntities: false
description: "Reassigning to specialist reviewer"
comment: "These require domain expertise"
responses:
'200':
description: Bulk reassignment completed successfully.
content:
application/json:
schema:
type: object
properties:
childSetId:
type: string
description: ID of the created or reused child set
movedEntityCount:
type: integer
description: Number of entities moved to the child set
example:
childSetId: "new-set-abc123"
movedEntityCount: 3
'400':
description: Bad request - missing required fields or invalid entity IDs.
'401':
description: Unauthorized.
'403':
description: Forbidden - insufficient rights.
'500':
description: Internal server error.
'/rest/metadataValidationSet/{setId}/metadataValidationItems':
patch:
operationId: core_MetadataValidationSetItemResource_patchItems
tags:
- Metadata Validation
summary: Applies reviewer metadata decisions to items in a validation set
description: Accepts either an object envelope with optional validateAllEntities/undoAllEntities flags, optional excludeEntityIds, plus an items array, or a legacy bare array of rows. Returns HTTP 200 when all rows succeed, HTTP 207 for partial success, or HTTP 400 when all rows fail.
parameters:
- in: path
name: setId
required: true
description: The metadata validation set identifier.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
validateAllEntities:
type: boolean
description: When true, validate all entities in the set
default: false
undoAllEntities:
type: boolean
description: When true, undo validation for all entities
default: false
excludeEntityIds:
type: array
description: Entity IDs to exclude from bulk operations
items:
type: string
items:
type: array
description: Array of item-level validation decisions
items:
type: object
properties:
entityId:
type: string
itemId:
type: string
action:
type: string
enum:
- validate
- undo
example:
validateAllEntities: false
items:
- entityId: "entity-001"
itemId: "item-001"
action: "validate"
- entityId: "entity-001"
itemId: "item-002"
action: "validate"
- entityId: "entity-002"
itemId: "item-003"
action: "undo"
responses:
'200':
description: All items patched successfully.
content:
application/json:
schema:
type: object
properties:
successCount:
type: integer
description: Number of items successfully patched
failureCount:
type: integer
description: Number of items that failed
failures:
type: array
description: Details of failed items
items:
type: object
example:
successCount: 3
failureCount: 0
failures: []
'207':
description: Partial success - some items patched, some failed.
content:
application/json:
schema:
type: object
example:
successCount: 2
failureCount: 1
failures:
- entityId: "entity-002"
itemId: "item-003"
error: "Item not found"
'400':
description: All items failed validation.
'401':
description: Unauthorized.
'403':
description: Forbidden - insufficient rights.
'500':
description: Internal server error.
/rest/modules/status:
get:
operationId: core_ModulesResource_getModulesStatus
tags:
- Modules
summary: Get modules status
description: Get modules status
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/modules/suggest/suggest/column/{class}/{column}':
post:
operationId: core_SuggestResource_getDistinctColumnSuggest_9
tags:
- Suggest
summary: Get distinct column suggest
description: Get distinct column suggest
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
- in: path
name: column
required: true
description: The column.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/modules/suggest/suggest/object/{class}':
post:
operationId: core_SuggestResource_getSuggest_9
tags:
- Suggest
summary: Returns a json data feed for a suggest component for the given class type
description: Returns a json data feed for a suggest component for the given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
get:
operationId: core_SuggestResource_simpleList_9
tags:
- Suggest
summary: Simple list
description: Simple list
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/modules/suggest/suggest/uiconfig:
post:
operationId: core_SuggestResource_getUIConfigSuggest_9
tags:
- Suggest
summary: Get ui config suggest
description: Get ui config suggest
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/modules/{module}/status':
get:
operationId: core_ModuleResource_getModuleStatus
tags:
- Modules
summary: Get module status
description: Get module status
parameters:
- in: path
name: module
required: true
description: The module path parameter.
schema:
type: string
- in: query
name: includeRequests
required: false
description: The includeRequests query parameter.
schema:
type: boolean
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: ModuleStatusDTO
example: {"statuses": [{}], "server": "example-server", "status": true, "ping": "example-ping", "outstandingRequest": true, "moduleName": "Example Module", "exceptionMessage": "Example message text"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: core_ModuleResource_requestModuleStatus
tags:
- Modules
summary: Request module status
description: Request module status
parameters:
- in: path
name: module
required: true
description: The module path parameter.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"module": "RoleMining", "action": "start"}
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/monitoringStatistics:
get:
operationId: core_MonitoringStatisticListResource_getMonitoringStatistics
tags:
- Monitoring
summary: Get monitoring statistics
description: Get monitoring statistics
parameters:
- in: query
name: excludeTemplates
required: false
description: The excludeTemplates query parameter.
schema:
type: boolean
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/notifications:
get:
operationId: core_NotificationsResource_getSettings
tags:
- Notifications
summary: Get settings
description: Get settings
parameters:
- in: query
name: certId
required: false
description: The certId query parameter.
schema:
type: string
- in: query
name: reminderNumber
required: false
description: The reminderNumber query parameter.
schema:
type: integer
format: int32
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: TypedResult
example: {"type": "ExampleType", "object": {"id": "abc-12345", "name": "Example Item"}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/notifications/reminder:
get:
operationId: core_NotificationsResource_getSettings_2
tags:
- Notifications
summary: Get settings
description: Get settings
parameters:
- in: query
name: certId
required: false
description: The certId query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: TypedResult
example: {"type": "ExampleType", "object": {"id": "abc-12345", "name": "Example Item"}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/oauth2/clients:
get:
operationId: core_OAuthClientListResource_list
tags:
- OAuth
summary: List
description: List
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: core_OAuthClientListResource_create
tags:
- OAuth
summary: Create
description: Create
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"name": "Example Item", "clientId": "abc-12345", "secret": "**hidden**", "createDate": "2024-01-01T00:00:00Z", "proxyUser": {}}
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/oauth2/clients/{nameOrId}':
get:
operationId: core_OAuthClientResource_get
tags:
- OAuth
summary: Handle GET request
description: Handle GET request
parameters:
- in: path
name: nameOrId
required: true
description: The nameOrId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
put:
operationId: core_OAuthClientResource_update
tags:
- OAuth
summary: Update
description: Update
parameters:
- in: path
name: nameOrId
required: true
description: The nameOrId path parameter.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"name": "Example Item", "clientId": "abc-12345", "secret": "**hidden**", "createDate": "2024-01-01T00:00:00Z", "proxyUser": {}}
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
delete:
operationId: core_OAuthClientResource_delete
tags:
- OAuth
summary: Delete
description: Delete
parameters:
- in: path
name: nameOrId
required: true
description: The nameOrId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/oauth2/clients/{nameOrId}/regenerateKeys':
post:
operationId: core_OAuthClientResource_regenerateKeys
tags:
- OAuth
summary: Regenerate keys
description: Regenerate keys
parameters:
- in: path
name: nameOrId
required: true
description: The nameOrId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/oauth2/clients/{nameOrId}/secret':
get:
operationId: core_OAuthClientResource_getSecret
tags:
- OAuth
summary: Handle GET request for individual secret
description: Handle GET request for individual secret
parameters:
- in: path
name: nameOrId
required: true
description: The nameOrId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/oauth2/configuration:
get:
operationId: core_OAuthConfigurationResource_get
tags:
- Configuration
summary: Get
description: Get
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
put:
operationId: core_OAuthConfigurationResource_update
tags:
- Configuration
summary: Update
description: Update
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"accessTokenExpiresInSeconds": "2024-01-01T00:00:00Z"}
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/objectConfig/attributes:
get:
operationId: core_ObjectConfigResource_getAttributesGrid
tags:
- Configuration
summary: Fetch the attributes for the specified ObjectConfig
description: Fetch the attributes for the specified ObjectConfig
parameters:
- in: query
name: configName
required: false
description: The configName query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"attributes": ["id", "name", "description"], "category": "example-category", "description": "Example description", "id": "abc-12345", "name": "Example Name", "totalCount": 25}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/passwordIntercept:
post:
operationId: core_PasswordInterceptResource_passwordIntercept
tags:
- Password
summary: Receive a password intercept event
description: Receive a password intercept event
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"identityName": "jsmith", "application": "Example Application", "nativeIdentity": "jsmith", "password": "**hidden**"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: string
example: "example-value"
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/passwordPolicy/invalidHashPolicies:
get:
operationId: core_PasswordPolicyResource_getInvalidHashPolicies
tags:
- Password
summary: 'Gets the names of any password policies, including the IIQ password policy, that have any constraints that conflict with one-way hashing of passwords'
description: 'Gets the names of any password policies, including the IIQ password policy, that have any constraints that conflict with one-way hashing of passwords'
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/passwordPolicy/mergeAllConstraints:
post:
operationId: core_PasswordPolicyResource_mergeAllConstraints
tags:
- Password
summary: 'Creates a display friendly unified set of constraints from all of an Identity''s account less the passed excluded accounts'
description: 'Creates a display friendly unified set of constraints from all of an Identity''s account less the passed excluded accounts'
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
object:
type: object
description: The returned object
example: {"object": {"id": "abc-12345", "name": "Example Item"}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/passwordPolicy/mergeConstraints:
post:
operationId: core_PasswordPolicyResource_getUnifiedConstraints
tags:
- Password
summary: Creates a display friendly unified set of constraints from various accounts
description: Creates a display friendly unified set of constraints from various accounts
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
object:
type: object
description: The returned object
example: {"object": {"id": "abc-12345", "name": "Example Item"}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/ping:
get:
operationId: core_IIQResource_ping
tags:
- IIQ
summary: Return a ping response
description: Return a ping response
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: string
example: "example-value"
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/plugins:
get:
operationId: core_PluginsListResource_getPlugins
tags:
- Plugins
summary: Gets a list of all plugins in the system
description: Gets a list of all plugins in the system
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: core_PluginsListResource_install
tags:
- Plugins
summary: Endpoint responsible for handling the zip file that contains the plugin
description: Endpoint responsible for handling the zip file that contains the plugin
requestBody:
content:
application/json:
schema:
type: object
description: String
example: "example-value"
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/plugins/{pluginId}':
get:
operationId: core_PluginResource_getPlugin
tags:
- Plugins
summary: Gets the Resource based on the plugin saved in the constructor
description: Gets the Resource based on the plugin saved in the constructor
parameters:
- in: path
name: pluginId
required: true
description: The pluginId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: PluginDTO
example: {"name": "Example Item", "displayName": "Example Display", "disabled": true, "version": "1.0", "installDate": "2024-01-01T00:00:00Z", "certificationLevel": "example-certificationLevel", "settings": [{"name": "Example Item", "dataType": "ExampleType", "value": "example-value", "label": "example-label", "helpText": "Example message text", "allowedValues": [{}], "defaultValue": "example-defaultValue", "multiValue": true}], "hasCustomSettings": true, "localizedCertLevel": "example-localizedCertLevel"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: core_PluginResource_saveConfiguration
tags:
- Plugins
summary: Updates the configuration on the plugin
description: Updates the configuration on the plugin
parameters:
- in: path
name: pluginId
required: true
description: The pluginId path parameter.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"disabled": "example-disabled", "intSetting": "example-intSetting"}
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
delete:
operationId: core_PluginResource_uninstallPlugin
tags:
- Plugins
summary: Uninstall plugin
description: Uninstall plugin
parameters:
- in: path
name: pluginId
required: true
description: The pluginId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/plugins/{pluginId}/settings':
get:
operationId: core_PluginResource_getSettings
tags:
- Plugins
summary: Gets settings information (as settings DTOs) for a plugin
description: Gets settings information (as settings DTOs) for a plugin
parameters:
- in: path
name: pluginId
required: true
description: The pluginId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: array
items:
type: object
example: [{"id": "12345", "name": "Example Item", "description": "Sample record"}]
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/plugins/{pluginId}/toggle':
post:
operationId: core_PluginResource_togglePlugin
tags:
- Plugins
summary: Toggles the disabled status of the plugin
description: Toggles the disabled status of the plugin
parameters:
- in: path
name: pluginId
required: true
description: The pluginId path parameter.
schema:
type: string
- in: query
name: disabled
required: false
description: The disabled query parameter.
schema:
type: boolean
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/plugins/{pluginId}/validatePluginName':
post:
operationId: core_PluginResource_validatePluginName
tags:
- Plugins
summary: Validates a plugin name to make sure it matches the name associated with the plugin id
description: Validates a plugin name to make sure it matches the name associated with the plugin id
parameters:
- in: path
name: pluginId
required: true
description: The pluginId path parameter.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
description: String
example: "example-value"
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/policies/checkPasswordPolicies:
post:
operationId: core_PolicyResource_checkPasswordPolicy
tags:
- Policy
summary: Check the given credentials against the password policies
description: Check the given credentials against the password policies
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"identityName": "jsmith", "application": "Example Application", "password": "**hidden**"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"identityName": "jsmith", "application": "Example Application", "password": "**hidden**"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/policies/checkRolePolicies:
get:
operationId: core_PolicyResource_checkRolePolicies
tags:
- Policy
summary: Check whether assigning the given roles to the given identity would result in role policy violations
description: Check whether assigning the given roles to the given identity would result in role policy violations
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: array
items:
type: object
example: [{"id": "12345", "name": "Example Item", "description": "Sample record"}]
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/provisioningTransactions:
get:
operationId: core_ProvisioningTransactionListResource_getTransactions
tags:
- Provisioning
summary: Get transactions
description: Get transactions
parameters:
- in: query
name: applicationName
required: false
description: The applicationName query parameter.
schema:
type: string
- in: query
name: identityName
required: false
description: The identityName query parameter.
schema:
type: string
- in: query
name: accountDisplayName
required: false
description: The accountDisplayName query parameter.
schema:
type: string
- in: query
name: status
required: false
description: The status query parameter.
schema:
type: string
- in: query
name: type
required: false
description: The type query parameter.
schema:
type: string
- in: query
name: source
required: false
description: The source query parameter.
schema:
type: string
- in: query
name: operation
required: false
description: The operation query parameter.
schema:
type: string
- in: query
name: startDateRange
required: false
description: The startDateRange query parameter.
schema:
type: string
- in: query
name: endDateRange
required: false
description: The endDateRange query parameter.
schema:
type: string
- in: query
name: integration
required: false
description: The integration query parameter.
schema:
type: string
- in: query
name: forced
required: false
description: The forced query parameter.
schema:
type: boolean
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/provisioningTransactions/runReport:
get:
operationId: core_ProvisioningTransactionListResource_runReport
tags:
- Provisioning
summary: Method for the UI to run the selected filters as a report
description: Method for the UI to run the selected filters as a report
parameters:
- in: query
name: applicationName
required: false
description: The applicationName query parameter.
schema:
type: string
- in: query
name: identityName
required: false
description: The identityName query parameter.
schema:
type: string
- in: query
name: accountDisplayName
required: false
description: The accountDisplayName query parameter.
schema:
type: string
- in: query
name: status
required: false
description: The status query parameter.
schema:
type: string
- in: query
name: type
required: false
description: The type query parameter.
schema:
type: string
- in: query
name: source
required: false
description: The source query parameter.
schema:
type: string
- in: query
name: operation
required: false
description: The operation query parameter.
schema:
type: string
- in: query
name: startDateRange
required: false
description: The startDateRange query parameter.
schema:
type: string
- in: query
name: endDateRange
required: false
description: The endDateRange query parameter.
schema:
type: string
- in: query
name: integration
required: false
description: The integration query parameter.
schema:
type: string
- in: query
name: forced
required: false
description: The forced query parameter.
schema:
type: boolean
- in: query
name: columns
required: false
description: The columns query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/provisioningTransactions/statusCounts:
get:
operationId: core_ProvisioningTransactionListResource_getStatusCount
tags:
- Provisioning
summary: Method for the UI to populate the number of PTOs that are on each tab
description: Method for the UI to populate the number of PTOs that are on each tab
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"columns": ["id", "name", "description"]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/provisioningTransactions/suggest/suggest/column/{class}/{column}':
post:
operationId: core_SuggestResource_getDistinctColumnSuggest_10
tags:
- Suggest
summary: Get distinct column suggest
description: Get distinct column suggest
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
- in: path
name: column
required: true
description: The column.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/provisioningTransactions/suggest/suggest/object/{class}':
post:
operationId: core_SuggestResource_getSuggest_10
tags:
- Suggest
summary: Returns a json data feed for a suggest component for the given class type
description: Returns a json data feed for a suggest component for the given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
get:
operationId: core_SuggestResource_simpleList_10
tags:
- Suggest
summary: Simple list
description: Simple list
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/provisioningTransactions/suggest/suggest/uiconfig:
post:
operationId: core_SuggestResource_getUIConfigSuggest_10
tags:
- Suggest
summary: Get ui config suggest
description: Get ui config suggest
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/provisioningTransactions/{transactionId}':
get:
operationId: core_ProvisioningTransactionResource_getTransaction
tags:
- Provisioning
summary: Get transaction
description: Get transaction
parameters:
- in: path
name: transactionId
required: true
description: The transactionId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: ProvisioningTransactionDTO
example: {"name": "Example Item", "operation": "example-operation", "source": "example-source", "applicationName": "Example Application", "identityName": "Example Identity", "identityDisplayName": "Example Identitydisplay", "nativeIdentity": "example-nativeIdentity", "accountDisplayName": "Example Accountdisplay", "status": {}, "statusMessage": "Example message text", "type": {}, "typeMessage": "Example message text", "integration": "example-integration", "forced": true, "forceable": true, "created": "2024-01-01T00:00:00Z", "modified": "2024-01-01T00:00:00Z", "retry": true, "lastRetry": "example-lastRetry", "retryCount": 1, "ticketId": "abc-12345", "timedOut": true, "result": "example-result", "manualWorkItem": "example-manualWorkItem", "certificationName": "Example Certification", "accessRequestId": "abc-12345", "errorMessages": ["example-value"], "attributeRequests": [{"operation": "example-operation", "name": "Example Item", "value": "example-value", "result": "example-result", "reason": "example-reason", "attributeRequest": true, "errorMessages": ["example-value"]}], "permissionRequests": [{"operation": "example-operation", "name": "Example Item", "value": "example-value", "result": "example-result", "reason": "example-reason", "attributeRequest": true, "errorMessages": ["example-value"]}], "filteredRequests": [{"operation": "example-operation", "name": "Example Item", "value": "example-value", "result": "example-result", "reason": "example-reason", "attributeRequest": true, "errorMessages": ["example-value"]}], "parentRequest": {}, "planResult": {"targetIntegration": "example-targetIntegration", "status": "Active", "requestID": "abc-12345", "warnings": [{}], "errors": [{}], "object": {}, "merged": [{}], "converted": [{}], "list": [{}], "resultMap": {"key": "value"}, "warnStringList": [{}], "msgInfo": {"key": "value"}, "localizedMessage": "Example message text", "errorStringList": [{}], "localizedMsg": "example-localizedMsg", "type": "ExampleType", "args": [{}], "msg": {}, "o": "example-o"}, "attributes": {"key": "value"}, "dto": {"operation": "example-operation", "name": "Example Item", "value": "example-value", "result": "example-result", "reason": "example-reason", "attributeRequest": true, "errorMessages": ["example-value"]}, "filteredRequest": {}, "reason": {}, "msg": {"id": "abc-12345", "dateCreated": 0, "type": {}, "senderCtx": {}, "messageText": "Example message text"}, "defaultResult": "example-defaultResult"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/provisioningTransactions/{transactionId}/force':
post:
operationId: core_ProvisioningTransactionResource_force
tags:
- Provisioning
summary: Attempts to force manual provisioning from a failed provisioning transaction object
description: Attempts to force manual provisioning from a failed provisioning transaction object
parameters:
- in: path
name: transactionId
required: true
description: The transactionId.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"comment": "Example description", "ownerId": "abc-12345"}
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/provisioningTransactions/{transactionId}/retry':
post:
operationId: core_ProvisioningTransactionResource_retry
tags:
- Provisioning
summary: Method for the UI to force a PTO to retry the associated request
description: Method for the UI to force a PTO to retry the associated request
parameters:
- in: path
name: transactionId
required: true
description: The transactionId.
schema:
type: string
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/quicklinks:
get:
operationId: core_QuickLinkListResource_getList
tags:
- Quick Links
summary: Return a ListResult of all QuickLinks
description: Return a ListResult of all QuickLinks
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/remoteLogin:
post:
operationId: core_IdentityResource_createRemoteLogin_2
tags:
- Identities
summary: 'Remote service to allow creating of remote login tokens to allow psuedo-sso for integrations that want to launch into our app given some user context'
description: 'Remote service to allow creating of remote login tokens to allow psuedo-sso for integrations that want to launch into our app given some user context'
requestBody:
content:
application/json:
schema:
type: object
description: String
example: "example-value"
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: string
example: "example-value"
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/report/schedule:
post:
operationId: core_ReportResource_schedule
tags:
- Reports
summary: Schedule
description: Schedule
requestBody:
content:
application/json:
schema:
type: object
description: MultivaluedMap
example: {"action": "example-action", "ascending": "example-ascending", "column": ["id", "name", "description"], "complete": "example-complete", "csv": "example-csv", "duplicateName": "Example Name", "endDate": "2024-01-01T00:00:00Z", "exception": "example-exception", "grid": "abc-12345", "isError": "example-isError", "isWarning": "example-isWarning", "pdf": "example-pdf", "percentComplete": "example-percentComplete", "position": "example-position", "progress": "example-progress", "scheduleId": "abc-12345", "startDate": 0, "status": "Active"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/report/{id}/chart':
get:
operationId: core_ReportResource_getPreviewChart
tags:
- Reports
summary: Get preview chart
description: Get preview chart
parameters:
- in: path
name: id
required: true
description: The id.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/report/{id}/data':
get:
operationId: core_ReportResource_getData
tags:
- Reports
summary: Get live report data for a given task definition
description: Get live report data for a given task definition
parameters:
- in: path
name: id
required: true
description: The id.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/report/{id}/file/{format}':
get:
operationId: core_ReportResource_getFile
tags:
- Reports
summary: Returns a stream containing the file for the given ID
description: Returns a stream containing the file for the given ID
parameters:
- in: path
name: id
required: true
description: The id.
schema:
type: string
- in: path
name: format
required: true
description: The format.
schema:
type: string
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/report/{id}/header':
get:
operationId: core_ReportResource_getPreviewHeader
tags:
- Reports
summary: Get preview header
description: Get preview header
parameters:
- in: path
name: id
required: true
description: The id.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/report/{id}/notification':
post:
operationId: core_ReportResource_addNotification
tags:
- Reports
summary: Add a completion notification to a given report
description: Add a completion notification to a given report
parameters:
- in: path
name: id
required: true
description: The id.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/report/{id}/progress':
get:
operationId: core_ReportResource_getProgress
tags:
- Reports
summary: Returns progress for the given TaskResult
description: Returns progress for the given TaskResult
parameters:
- in: path
name: id
required: true
description: The id.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/report/{id}/results':
get:
operationId: core_ReportResource_getResults
tags:
- Reports
summary: Add report results for a given TaskResult
description: Add report results for a given TaskResult
parameters:
- in: path
name: id
required: true
description: The id.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/report/{id}/summary':
get:
operationId: core_ReportResource_getPreviewSummary
tags:
- Reports
summary: Get preview summary
description: Get preview summary
parameters:
- in: path
name: id
required: true
description: The id.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/rest/report/{id}/updateLayout':
post:
operationId: core_ReportResource_updateLayout
tags:
- Reports
summary: Update the layout for a given report
description: Update the layout for a given report
parameters:
- in: path
name: id
required: true
description: The id.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/requestAccess/types:
get:
operationId: core_RequestAccessResource_getTypes
tags:
- Access Requests
summary: Get types
description: Get types
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/requests/list:
post:
operationId: core_RequestResource_list
tags:
- Requests
summary: Get filtered list of Request objects for the requests
description: Get filtered list of Request objects for the requests
requestBody:
content:
application/json:
schema:
type: object
description: MultivaluedMap
example: {"displayName": "Example Name", "id": "abc-12345"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/requests/typeList:
get:
operationId: core_RequestResource_getRequestDefinitionTypes
tags:
- Requests
summary: Get the list of possible Request Definition Types
description: Get the list of possible Request Definition Types
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/rights/validate:
post:
operationId: core_RightsResource_validateRights
tags:
- Rights
summary: This method checks if the loggedInUser has the rights given in rights list
description: This method checks if the loggedInUser has the rights given in rights list
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"rights": "example-rights"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: RightsResponseDTO
example: {"data": {"key": "value"}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/roleEditor/disallowedAttributes:
post:
operationId: core_RoleEditResource_getDisallowedAttributesForType
tags:
- Roles
summary: Returns List of extended attribute names that are unavailable for the specified role type
description: Returns List of extended attribute names that are unavailable for the specified role type
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: array
items:
type: object
example: [{"id": "12345", "name": "Example Item", "description": "Sample record"}]
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/roleMining/failureInfo:
post:
operationId: core_RoleMiningResource_getFailureInfo
tags:
- Role Mining
summary: Get failure info
description: Get failure info
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"errorMsg": "example-errorMsg", "id": "abc-12345", "identityFilterInfo": "abc-12345", "identityFilterType": "abc-12345", "inactive": true, "ipop": "example-ipop", "isAvailable": "example-isAvailable", "isTerminated": "example-isTerminated", "isViewable": "example-isViewable", "lastTaskResult": "example-lastTaskResult", "manager": "example-manager", "managerStatus": "Active", "msg": "example-msg", "stringifiedJSON": "example-stringifiedJSON", "type": "Identity"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/roleMining/getViewableTask:
post:
operationId: core_RoleMiningResource_getViewableTask
tags:
- Role Mining
summary: Get viewable task
description: Get viewable task
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"errorMsg": "example-errorMsg", "id": "abc-12345", "identityFilterInfo": "abc-12345", "identityFilterType": "abc-12345", "inactive": true, "ipop": "example-ipop", "isAvailable": "example-isAvailable", "isTerminated": "example-isTerminated", "isViewable": "example-isViewable", "lastTaskResult": "example-lastTaskResult", "manager": "example-manager", "managerStatus": "Active", "msg": "example-msg", "stringifiedJSON": "example-stringifiedJSON", "type": "Identity"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/rest/roleMining/it/filterInfo:
post:
operationId: core_RoleMiningResource_getItRoleMiningFilterInfo
tags:
- Role Mining
summary: 'Return the specified result''s filter information in this form:
{ isAvailable: , identityFilterInfo: { identityFilterType: { isAvailable: , identityFilterInfo: { identityFilterType: Correlation tab'
description: 'Returns Operators for dropdown in ConditionBasedCorrelation -> Correlation tab'
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/accessHistory/identities/suggest/suggest/provisioningActions:
get:
operationId: ui_SuggestResource_getProvisioningActionSuggest
tags:
- UI Suggest
summary: This endpoint returns list of provisioning actions in unstructured target page
description: This endpoint returns list of provisioning actions in unstructured target page
parameters:
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
- in: query
name: targetSourceType
required: false
description: The targetSourceType query parameter.
schema:
type: string
- in: query
name: provisioningOverridden
required: false
description: The provisioningOverridden query parameter.
schema:
type: boolean
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/accessHistory/identities/suggest/suggest/targetSourceTypes:
get:
operationId: ui_SuggestResource_getTargetSourceTypesSuggest
tags:
- UI Suggest
summary: This endpoint returns List of TargetSourceTypes corresponding to application type inside unstructured targets tab in the functionality of add/edit application
description: This endpoint returns List of TargetSourceTypes corresponding to application type inside unstructured targets tab in the functionality of add/edit application
parameters:
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/accessHistory/identities/suggest/suggest/targetSources:
get:
operationId: ui_SuggestResource_getTargetSourcesSuggest
tags:
- UI Suggest
summary: This endpoint returns List of TargetSources which are relevant for the application corresponding to application type inside unstructured targets tab in the functionality of add/edit application
description: This endpoint returns List of TargetSources which are relevant for the application corresponding to application type inside unstructured targets tab in the functionality of add/edit application
parameters:
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/accessHistory/identities/{identityId}/events':
get:
operationId: ui_HistoricalIdentityEventListResource_getHistoricalIdentityEventList
tags:
- UI Identities
summary: Get a filtered list of events
description: Get a filtered list of events
parameters:
- in: path
name: identityId
required: true
description: The identityId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/appOnboard/applicationAttributeFilters/{appId}':
get:
operationId: ui_ApplicationOnboardResource_getApplicationAttributeFilters
tags:
- UI App Onboarding
summary: Gets a list of Application Attributes for the given Application ID (as filters)
description: Gets a list of Application Attributes for the given Application ID (as filters)
parameters:
- in: path
name: appId
required: true
description: The appId.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: array
items:
type: object
example: [{"id": "12345", "name": "Example Item", "description": "Sample record"}]
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/appOnboard/applicationAttributeFiltersSuggest/{appId}/suggest/activityDataSourceTypes':
get:
operationId: ui_SuggestResource_getActivityDataSourceTypesSuggest_2
tags:
- UI Suggest
summary: This endpoint returns List of ActivityDataSourceTypes
description: This endpoint returns List of ActivityDataSourceTypes
parameters:
- in: path
name: appId
required: true
description: The appId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/appOnboard/applicationAttributeFiltersSuggest/{appId}/suggest/applicationAttributes':
get:
operationId: ui_SuggestResource_getApplicationAttributes_2
tags:
- UI Suggest
summary: Returns data for ApplicationAttributes dropdown in Application Definition screen
description: Returns data for ApplicationAttributes dropdown in Application Definition screen
parameters:
- in: path
name: appId
required: true
description: The appId path parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appName
required: false
description: The appName query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/appOnboard/applicationAttributeFiltersSuggest/{appId}/suggest/applications':
get:
operationId: ui_ApplicationSuggestResource_getApplications_2
tags:
- UI Suggest
summary: List of application maps for all applications
description: List of application maps for all applications
parameters:
- in: path
name: appId
required: true
description: The appId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/appOnboard/applicationAttributeFiltersSuggest/{appId}/suggest/applications/attributeValues':
post:
operationId: ui_ApplicationSuggestResource_getAttributeValues_2
tags:
- UI Suggest
summary: List of values for the given list of application and attribute
description: List of values for the given list of application and attribute
parameters:
- in: path
name: appId
required: true
description: The appId path parameter.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"applications": "Example Application", "attributes": ["id", "name", "description"], "limit": 25, "query": "name sw \"example\"", "start": 0}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/appOnboard/applicationAttributeFiltersSuggest/{appId}/suggest/column/{class}/{column}':
get:
operationId: ui_SuggestResource_getColumnSuggestViaHttpGet_2
tags:
- UI Suggest
summary: Returns a list of results for a suggest containing distinct column values on a given class type
description: Returns a list of results for a suggest containing distinct column values on a given class type
parameters:
- in: path
name: appId
required: true
description: The appId path parameter.
schema:
type: string
- in: path
name: class
required: true
description: The class.
schema:
type: string
- in: path
name: column
required: true
description: The column.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: ui_SuggestResource_getColumnSuggestViaHttpPost_2
tags:
- UI Suggest
summary: Returns a list of results for a suggest containing distinct column values on a given class type
description: Returns a list of results for a suggest containing distinct column values on a given class type
parameters:
- in: path
name: appId
required: true
description: The appId path parameter.
schema:
type: string
- in: path
name: class
required: true
description: The class.
schema:
type: string
- in: path
name: column
required: true
description: The column.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"displayName": "Example Name", "value": "example-value"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/appOnboard/applicationAttributeFiltersSuggest/{appId}/suggest/identityAttributes':
get:
operationId: ui_SuggestResource_getIdentityAttributes_2
tags:
- UI Suggest
summary: Returns data for IdentityAttributes dropdown in Application Definition Screen
description: Returns data for IdentityAttributes dropdown in Application Definition Screen
parameters:
- in: path
name: appId
required: true
description: The appId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/appOnboard/applicationAttributeFiltersSuggest/{appId}/suggest/object/{class}':
get:
operationId: ui_SuggestResource_getSuggestViaHttpGet_2
tags:
- UI Suggest
summary: Returns a json data feed for a suggest component for the given class type
description: Returns a json data feed for a suggest component for the given class type
parameters:
- in: path
name: appId
required: true
description: The appId path parameter.
schema:
type: string
- in: path
name: class
required: true
description: The class.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: ui_SuggestResource_getSuggestViaHttpPost_2
tags:
- UI Suggest
summary: Returns a json data feed for a suggest component for the given class type
description: Returns a json data feed for a suggest component for the given class type
parameters:
- in: path
name: appId
required: true
description: The appId path parameter.
schema:
type: string
- in: path
name: class
required: true
description: The class.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"displayName": "Example Name", "value": "example-value"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/appOnboard/applicationAttributeFiltersSuggest/{appId}/suggest/operators':
get:
operationId: ui_SuggestResource_getOperators_2
tags:
- UI Suggest
summary: 'Returns Operators for dropdown in ConditionBasedCorrelation -> Correlation tab'
description: 'Returns Operators for dropdown in ConditionBasedCorrelation -> Correlation tab'
parameters:
- in: path
name: appId
required: true
description: The appId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/appOnboard/applicationAttributeFiltersSuggest/{appId}/suggest/provisioningActions':
get:
operationId: ui_SuggestResource_getProvisioningActionSuggest_2
tags:
- UI Suggest
summary: This endpoint returns list of provisioning actions in unstructured target page
description: This endpoint returns list of provisioning actions in unstructured target page
parameters:
- in: path
name: appId
required: true
description: The appId path parameter.
schema:
type: string
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
- in: query
name: targetSourceType
required: false
description: The targetSourceType query parameter.
schema:
type: string
- in: query
name: provisioningOverridden
required: false
description: The provisioningOverridden query parameter.
schema:
type: boolean
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/appOnboard/applicationAttributeFiltersSuggest/{appId}/suggest/targetSourceTypes':
get:
operationId: ui_SuggestResource_getTargetSourceTypesSuggest_2
tags:
- UI Suggest
summary: This endpoint returns List of TargetSourceTypes corresponding to application type inside unstructured targets tab in the functionality of add/edit application
description: This endpoint returns List of TargetSourceTypes corresponding to application type inside unstructured targets tab in the functionality of add/edit application
parameters:
- in: path
name: appId
required: true
description: The appId path parameter.
schema:
type: string
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/appOnboard/applicationAttributeFiltersSuggest/{appId}/suggest/targetSources':
get:
operationId: ui_SuggestResource_getTargetSourcesSuggest_2
tags:
- UI Suggest
summary: This endpoint returns List of TargetSources which are relevant for the application corresponding to application type inside unstructured targets tab in the functionality of add/edit application
description: This endpoint returns List of TargetSources which are relevant for the application corresponding to application type inside unstructured targets tab in the functionality of add/edit application
parameters:
- in: path
name: appId
required: true
description: The appId path parameter.
schema:
type: string
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/appOnboard/applicationAttributeSuggestFilters/{appId}':
get:
operationId: ui_ApplicationOnboardResource_getApplicationAttributeSuggestFilters
tags:
- UI App Onboarding
summary: Gets a list of Application Attributes for the given Application ID (as filters)
description: Gets a list of Application Attributes for the given Application ID (as filters)
parameters:
- in: path
name: appId
required: true
description: The appId.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: array
items:
type: object
example: [{"id": "12345", "name": "Example Item", "description": "Sample record"}]
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/appOnboard/applicationAttributeSuggestFiltersSuggest/{appId}/suggest/activityDataSourceTypes':
get:
operationId: ui_SuggestResource_getActivityDataSourceTypesSuggest_3
tags:
- UI Suggest
summary: This endpoint returns List of ActivityDataSourceTypes
description: This endpoint returns List of ActivityDataSourceTypes
parameters:
- in: path
name: appId
required: true
description: The appId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/appOnboard/applicationAttributeSuggestFiltersSuggest/{appId}/suggest/applicationAttributes':
get:
operationId: ui_SuggestResource_getApplicationAttributes_3
tags:
- UI Suggest
summary: Returns data for ApplicationAttributes dropdown in Application Definition screen
description: Returns data for ApplicationAttributes dropdown in Application Definition screen
parameters:
- in: path
name: appId
required: true
description: The appId path parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appName
required: false
description: The appName query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/appOnboard/applicationAttributeSuggestFiltersSuggest/{appId}/suggest/applications':
get:
operationId: ui_ApplicationSuggestResource_getApplications_3
tags:
- UI Suggest
summary: List of application maps for all applications
description: List of application maps for all applications
parameters:
- in: path
name: appId
required: true
description: The appId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/appOnboard/applicationAttributeSuggestFiltersSuggest/{appId}/suggest/applications/attributeValues':
post:
operationId: ui_ApplicationSuggestResource_getAttributeValues_3
tags:
- UI Suggest
summary: List of values for the given list of application and attribute
description: List of values for the given list of application and attribute
parameters:
- in: path
name: appId
required: true
description: The appId path parameter.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"applications": "Example Application", "attributes": ["id", "name", "description"], "limit": 25, "query": "name sw \"example\"", "start": 0}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/appOnboard/applicationAttributeSuggestFiltersSuggest/{appId}/suggest/column/{class}/{column}':
get:
operationId: ui_SuggestResource_getColumnSuggestViaHttpGet_3
tags:
- UI Suggest
summary: Returns a list of results for a suggest containing distinct column values on a given class type
description: Returns a list of results for a suggest containing distinct column values on a given class type
parameters:
- in: path
name: appId
required: true
description: The appId path parameter.
schema:
type: string
- in: path
name: class
required: true
description: The class.
schema:
type: string
- in: path
name: column
required: true
description: The column.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: ui_SuggestResource_getColumnSuggestViaHttpPost_3
tags:
- UI Suggest
summary: Returns a list of results for a suggest containing distinct column values on a given class type
description: Returns a list of results for a suggest containing distinct column values on a given class type
parameters:
- in: path
name: appId
required: true
description: The appId path parameter.
schema:
type: string
- in: path
name: class
required: true
description: The class.
schema:
type: string
- in: path
name: column
required: true
description: The column.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"displayName": "Example Name", "value": "example-value"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/appOnboard/applicationAttributeSuggestFiltersSuggest/{appId}/suggest/identityAttributes':
get:
operationId: ui_SuggestResource_getIdentityAttributes_3
tags:
- UI Suggest
summary: Returns data for IdentityAttributes dropdown in Application Definition Screen
description: Returns data for IdentityAttributes dropdown in Application Definition Screen
parameters:
- in: path
name: appId
required: true
description: The appId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/appOnboard/applicationAttributeSuggestFiltersSuggest/{appId}/suggest/object/{class}':
get:
operationId: ui_SuggestResource_getSuggestViaHttpGet_3
tags:
- UI Suggest
summary: Returns a json data feed for a suggest component for the given class type
description: Returns a json data feed for a suggest component for the given class type
parameters:
- in: path
name: appId
required: true
description: The appId path parameter.
schema:
type: string
- in: path
name: class
required: true
description: The class.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: ui_SuggestResource_getSuggestViaHttpPost_3
tags:
- UI Suggest
summary: Returns a json data feed for a suggest component for the given class type
description: Returns a json data feed for a suggest component for the given class type
parameters:
- in: path
name: appId
required: true
description: The appId path parameter.
schema:
type: string
- in: path
name: class
required: true
description: The class.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"displayName": "Example Name", "value": "example-value"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/appOnboard/applicationAttributeSuggestFiltersSuggest/{appId}/suggest/operators':
get:
operationId: ui_SuggestResource_getOperators_3
tags:
- UI Suggest
summary: 'Returns Operators for dropdown in ConditionBasedCorrelation -> Correlation tab'
description: 'Returns Operators for dropdown in ConditionBasedCorrelation -> Correlation tab'
parameters:
- in: path
name: appId
required: true
description: The appId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/appOnboard/applicationAttributeSuggestFiltersSuggest/{appId}/suggest/provisioningActions':
get:
operationId: ui_SuggestResource_getProvisioningActionSuggest_3
tags:
- UI Suggest
summary: This endpoint returns list of provisioning actions in unstructured target page
description: This endpoint returns list of provisioning actions in unstructured target page
parameters:
- in: path
name: appId
required: true
description: The appId path parameter.
schema:
type: string
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
- in: query
name: targetSourceType
required: false
description: The targetSourceType query parameter.
schema:
type: string
- in: query
name: provisioningOverridden
required: false
description: The provisioningOverridden query parameter.
schema:
type: boolean
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/appOnboard/applicationAttributeSuggestFiltersSuggest/{appId}/suggest/targetSourceTypes':
get:
operationId: ui_SuggestResource_getTargetSourceTypesSuggest_3
tags:
- UI Suggest
summary: This endpoint returns List of TargetSourceTypes corresponding to application type inside unstructured targets tab in the functionality of add/edit application
description: This endpoint returns List of TargetSourceTypes corresponding to application type inside unstructured targets tab in the functionality of add/edit application
parameters:
- in: path
name: appId
required: true
description: The appId path parameter.
schema:
type: string
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/appOnboard/applicationAttributeSuggestFiltersSuggest/{appId}/suggest/targetSources':
get:
operationId: ui_SuggestResource_getTargetSourcesSuggest_3
tags:
- UI Suggest
summary: This endpoint returns List of TargetSources which are relevant for the application corresponding to application type inside unstructured targets tab in the functionality of add/edit application
description: This endpoint returns List of TargetSources which are relevant for the application corresponding to application type inside unstructured targets tab in the functionality of add/edit application
parameters:
- in: path
name: appId
required: true
description: The appId path parameter.
schema:
type: string
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/appOnboard/globalSettings:
get:
operationId: ui_ApplicationOnboardResource_getGlobalSettings
tags:
- UI App Onboarding
summary: 'Return an ApplicationOnboardDTO with the full current RapidSetup configuration, with no ApplicationDTO'
description: 'Return an ApplicationOnboardDTO with the full current RapidSetup configuration, with no ApplicationDTO'
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: ApplicationOnboardDTO
example: {"applicationDTO": {"id": "abc-12345", "name": "Example Item", "description": "A brief description.", "type": "ExampleType", "owner": {}, "remediators": [{}]}, "configAttributes": {"key": "value"}, "thresholdMap": {"key": "value"}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
put:
operationId: ui_ApplicationOnboardResource_updateGlobalSettings
tags:
- UI App Onboarding
summary: Update the RapidSetup Configuration object (except for "application")
description: Update the RapidSetup Configuration object (except for "application")
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"attr": "example-attr", "disableAccountFilter": "name sw \"example\"", "identityCorrelationFilter": "abc-12345", "lockAccountFilter": "name sw \"example\"", "managerCorrelationFilter": "name sw \"example\"", "msg": "example-msg", "rpaAccountFilter": "name sw \"example\"", "serviceAccountFilter": "name sw \"example\""}
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/appOnboard/identityAttributeFilters:
get:
operationId: ui_ApplicationOnboardResource_getIdentityAttributeFilters
tags:
- UI App Onboarding
summary: Gets a list of Identity Extended Attributes (as filters)
description: Gets a list of Identity Extended Attributes (as filters)
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: array
items:
type: object
example: [{"id": "12345", "name": "Example Item", "description": "Sample record"}]
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/appOnboard/identityAttributeFiltersSuggest/suggest/activityDataSourceTypes:
get:
operationId: ui_SuggestResource_getActivityDataSourceTypesSuggest_4
tags:
- UI Suggest
summary: This endpoint returns List of ActivityDataSourceTypes
description: This endpoint returns List of ActivityDataSourceTypes
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/appOnboard/identityAttributeFiltersSuggest/suggest/applicationAttributes:
get:
operationId: ui_SuggestResource_getApplicationAttributes_4
tags:
- UI Suggest
summary: Returns data for ApplicationAttributes dropdown in Application Definition screen
description: Returns data for ApplicationAttributes dropdown in Application Definition screen
parameters:
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appName
required: false
description: The appName query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/appOnboard/identityAttributeFiltersSuggest/suggest/applications:
get:
operationId: ui_ApplicationSuggestResource_getApplications_4
tags:
- UI Suggest
summary: List of application maps for all applications
description: List of application maps for all applications
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/appOnboard/identityAttributeFiltersSuggest/suggest/applications/attributeValues:
post:
operationId: ui_ApplicationSuggestResource_getAttributeValues_4
tags:
- UI Suggest
summary: List of values for the given list of application and attribute
description: List of values for the given list of application and attribute
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"applications": "Example Application", "attributes": ["id", "name", "description"], "limit": 25, "query": "name sw \"example\"", "start": 0}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/appOnboard/identityAttributeFiltersSuggest/suggest/column/{class}/{column}':
get:
operationId: ui_SuggestResource_getColumnSuggestViaHttpGet_4
tags:
- UI Suggest
summary: Returns a list of results for a suggest containing distinct column values on a given class type
description: Returns a list of results for a suggest containing distinct column values on a given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
- in: path
name: column
required: true
description: The column.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: ui_SuggestResource_getColumnSuggestViaHttpPost_4
tags:
- UI Suggest
summary: Returns a list of results for a suggest containing distinct column values on a given class type
description: Returns a list of results for a suggest containing distinct column values on a given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
- in: path
name: column
required: true
description: The column.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"displayName": "Example Name", "value": "example-value"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/appOnboard/identityAttributeFiltersSuggest/suggest/identityAttributes:
get:
operationId: ui_SuggestResource_getIdentityAttributes_4
tags:
- UI Suggest
summary: Returns data for IdentityAttributes dropdown in Application Definition Screen
description: Returns data for IdentityAttributes dropdown in Application Definition Screen
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/appOnboard/identityAttributeFiltersSuggest/suggest/object/{class}':
get:
operationId: ui_SuggestResource_getSuggestViaHttpGet_4
tags:
- UI Suggest
summary: Returns a json data feed for a suggest component for the given class type
description: Returns a json data feed for a suggest component for the given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: ui_SuggestResource_getSuggestViaHttpPost_4
tags:
- UI Suggest
summary: Returns a json data feed for a suggest component for the given class type
description: Returns a json data feed for a suggest component for the given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"displayName": "Example Name", "value": "example-value"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/appOnboard/identityAttributeFiltersSuggest/suggest/operators:
get:
operationId: ui_SuggestResource_getOperators_4
tags:
- UI Suggest
summary: 'Returns Operators for dropdown in ConditionBasedCorrelation -> Correlation tab'
description: 'Returns Operators for dropdown in ConditionBasedCorrelation -> Correlation tab'
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/appOnboard/identityAttributeFiltersSuggest/suggest/provisioningActions:
get:
operationId: ui_SuggestResource_getProvisioningActionSuggest_4
tags:
- UI Suggest
summary: This endpoint returns list of provisioning actions in unstructured target page
description: This endpoint returns list of provisioning actions in unstructured target page
parameters:
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
- in: query
name: targetSourceType
required: false
description: The targetSourceType query parameter.
schema:
type: string
- in: query
name: provisioningOverridden
required: false
description: The provisioningOverridden query parameter.
schema:
type: boolean
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/appOnboard/identityAttributeFiltersSuggest/suggest/targetSourceTypes:
get:
operationId: ui_SuggestResource_getTargetSourceTypesSuggest_4
tags:
- UI Suggest
summary: This endpoint returns List of TargetSourceTypes corresponding to application type inside unstructured targets tab in the functionality of add/edit application
description: This endpoint returns List of TargetSourceTypes corresponding to application type inside unstructured targets tab in the functionality of add/edit application
parameters:
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/appOnboard/identityAttributeFiltersSuggest/suggest/targetSources:
get:
operationId: ui_SuggestResource_getTargetSourcesSuggest_4
tags:
- UI Suggest
summary: This endpoint returns List of TargetSources which are relevant for the application corresponding to application type inside unstructured targets tab in the functionality of add/edit application
description: This endpoint returns List of TargetSources which are relevant for the application corresponding to application type inside unstructured targets tab in the functionality of add/edit application
parameters:
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/appOnboard/ownableArtifactTypes:
get:
operationId: ui_ApplicationOnboardResource_getOwnableSailPointObjectClasses
tags:
- UI App Onboarding
summary: Gets a list of Ownable SailPoint Object Major Classes
description: Gets a list of Ownable SailPoint Object Major Classes
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: array
items:
type: object
example: [{"items": [{}], "id": {}, "displayName": "Example Display"}]
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/appOnboard/roleTypes:
get:
operationId: ui_ApplicationOnboardResource_getRoleTypes
tags:
- UI App Onboarding
summary: Gets a list of Role Types used to select which role types are Birthright roles
description: Gets a list of Role Types used to select which role types are Birthright roles
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: array
items:
type: object
example: [{"id": "12345", "name": "Example Item", "description": "Sample record"}]
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/appOnboard/suggest/suggest/activityDataSourceTypes:
get:
operationId: ui_SuggestResource_getActivityDataSourceTypesSuggest_5
tags:
- UI Suggest
summary: This endpoint returns List of ActivityDataSourceTypes
description: This endpoint returns List of ActivityDataSourceTypes
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/appOnboard/suggest/suggest/applicationAttributes:
get:
operationId: ui_SuggestResource_getApplicationAttributes_5
tags:
- UI Suggest
summary: Returns data for ApplicationAttributes dropdown in Application Definition screen
description: Returns data for ApplicationAttributes dropdown in Application Definition screen
parameters:
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appName
required: false
description: The appName query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/appOnboard/suggest/suggest/applications:
get:
operationId: ui_ApplicationSuggestResource_getApplications_5
tags:
- UI Suggest
summary: List of application maps for all applications
description: List of application maps for all applications
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/appOnboard/suggest/suggest/applications/attributeValues:
post:
operationId: ui_ApplicationSuggestResource_getAttributeValues_5
tags:
- UI Suggest
summary: List of values for the given list of application and attribute
description: List of values for the given list of application and attribute
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"applications": "Example Application", "attributes": ["id", "name", "description"], "limit": 25, "query": "name sw \"example\"", "start": 0}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/appOnboard/suggest/suggest/column/{class}/{column}':
get:
operationId: ui_SuggestResource_getColumnSuggestViaHttpGet_5
tags:
- UI Suggest
summary: Returns a list of results for a suggest containing distinct column values on a given class type
description: Returns a list of results for a suggest containing distinct column values on a given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
- in: path
name: column
required: true
description: The column.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: ui_SuggestResource_getColumnSuggestViaHttpPost_5
tags:
- UI Suggest
summary: Returns a list of results for a suggest containing distinct column values on a given class type
description: Returns a list of results for a suggest containing distinct column values on a given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
- in: path
name: column
required: true
description: The column.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"displayName": "Example Name", "value": "example-value"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/appOnboard/suggest/suggest/identityAttributes:
get:
operationId: ui_SuggestResource_getIdentityAttributes_5
tags:
- UI Suggest
summary: Returns data for IdentityAttributes dropdown in Application Definition Screen
description: Returns data for IdentityAttributes dropdown in Application Definition Screen
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/appOnboard/suggest/suggest/object/{class}':
get:
operationId: ui_SuggestResource_getSuggestViaHttpGet_5
tags:
- UI Suggest
summary: Returns a json data feed for a suggest component for the given class type
description: Returns a json data feed for a suggest component for the given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: ui_SuggestResource_getSuggestViaHttpPost_5
tags:
- UI Suggest
summary: Returns a json data feed for a suggest component for the given class type
description: Returns a json data feed for a suggest component for the given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"displayName": "Example Name", "value": "example-value"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/appOnboard/suggest/suggest/operators:
get:
operationId: ui_SuggestResource_getOperators_5
tags:
- UI Suggest
summary: 'Returns Operators for dropdown in ConditionBasedCorrelation -> Correlation tab'
description: 'Returns Operators for dropdown in ConditionBasedCorrelation -> Correlation tab'
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/appOnboard/suggest/suggest/provisioningActions:
get:
operationId: ui_SuggestResource_getProvisioningActionSuggest_5
tags:
- UI Suggest
summary: This endpoint returns list of provisioning actions in unstructured target page
description: This endpoint returns list of provisioning actions in unstructured target page
parameters:
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
- in: query
name: targetSourceType
required: false
description: The targetSourceType query parameter.
schema:
type: string
- in: query
name: provisioningOverridden
required: false
description: The provisioningOverridden query parameter.
schema:
type: boolean
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/appOnboard/suggest/suggest/targetSourceTypes:
get:
operationId: ui_SuggestResource_getTargetSourceTypesSuggest_5
tags:
- UI Suggest
summary: This endpoint returns List of TargetSourceTypes corresponding to application type inside unstructured targets tab in the functionality of add/edit application
description: This endpoint returns List of TargetSourceTypes corresponding to application type inside unstructured targets tab in the functionality of add/edit application
parameters:
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/appOnboard/suggest/suggest/targetSources:
get:
operationId: ui_SuggestResource_getTargetSourcesSuggest_5
tags:
- UI Suggest
summary: This endpoint returns List of TargetSources which are relevant for the application corresponding to application type inside unstructured targets tab in the functionality of add/edit application
description: This endpoint returns List of TargetSources which are relevant for the application corresponding to application type inside unstructured targets tab in the functionality of add/edit application
parameters:
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/appOnboard/{appId}':
get:
operationId: ui_ApplicationOnboardResource_getApplicationOnboard
tags:
- UI App Onboarding
summary: 'Return an ApplicationOnboardDTO, include the ApplicationDTO'
description: 'Return an ApplicationOnboardDTO, include the ApplicationDTO'
parameters:
- in: path
name: appId
required: true
description: The appId.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: ApplicationOnboardDTO
example: {"applicationDTO": {"id": "abc-12345", "name": "Example Item", "description": "A brief description.", "type": "ExampleType", "owner": {}, "remediators": [{}]}, "configAttributes": {"key": "value"}, "thresholdMap": {"key": "value"}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/approvals:
get:
operationId: ui_ApprovalWorkItemListResource_getApprovals
tags:
- UI Approvals
summary: List all the approval work items of the specified type of identity request
description: List all the approval work items of the specified type of identity request
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/approvals/approvalConfigDTOS:
get:
operationId: ui_ApprovalWorkItemListResource_getApprovalConfigDTOS
tags:
- UI Approvals
summary: Get approval configuration DTO objects from a specific workflowcase
description: Get approval configuration DTO objects from a specific workflowcase
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: array
items:
type: object
example: [{"id": "12345", "name": "Example Item", "description": "Sample record"}]
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/approvals/count:
get:
operationId: ui_ApprovalWorkItemListResource_getApprovalsCount
tags:
- UI Approvals
summary: Get count of approval work items of the specified type of identity request
description: Get count of approval work items of the specified type of identity request
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: integer
example: 0
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/approvals/filters:
get:
operationId: ui_ApprovalWorkItemListResource_getFilterList
tags:
- UI Approvals
summary: Gets the list of filters available to the approval list page filter panel
description: Gets the list of filters available to the approval list page filter panel
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: array
items:
type: object
example: [{"id": "12345", "name": "Example Item", "description": "Sample record"}]
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/approvals/{workItemId}':
get:
operationId: ui_ApprovalWorkItemResource_getApproval
tags:
- UI Approvals
summary: Return the approval for this endpoint
description: Return the approval for this endpoint
parameters:
- in: path
name: workItemId
required: true
description: The workItemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: WorkItemDTO
example: {"created": "2024-01-01T00:00:00Z", "workItemName": "Example Workitem", "accessRequestName": "Example Accessrequest", "owner": {"name": "Example Item", "firstName": "Example First", "lastName": "Example Last", "displayName": "Example Display", "workgroup": true, "pseudo": true, "locked": true}, "assignee": {"name": "Example Item", "firstName": "Example First", "lastName": "Example Last", "displayName": "Example Display", "workgroup": true, "pseudo": true, "locked": true}, "requester": {"name": "Example Item", "firstName": "Example First", "lastName": "Example Last", "displayName": "Example Display", "workgroup": true, "pseudo": true, "locked": true}, "target": {"name": "Example Item", "firstName": "Example First", "lastName": "Example Last", "displayName": "Example Display", "workgroup": true, "pseudo": true, "locked": true}, "commentCount": 1, "esigMeaning": "example-esigMeaning", "editable": true, "description": "A brief description.", "notificationDate": "2024-01-01T00:00:00Z", "expirationDate": "2024-01-01T00:00:00Z", "wakeUpDate": "2024-01-01T00:00:00Z", "reminders": 0, "escalationCount": 1, "completionComments": "example-completionComments", "forceClassicApprovalUI": true, "certificationId": "abc-12345", "newTypeWorkItem": true, "disableForwarding": true, "id": "abc-12345", "workItemService": {"workItem": {}, "userContext": {}, "wfSession": {}, "factory": {}, "authorizer": {}, "fields": ["example-value"], "violation": {}, "violationMap": {"key": "value"}, "attributeViolations": [{}], "detailer": {}, "owner": "jsmith", "wf": {}, "item": {}, "comments": [{}], "newOwner": {}, "assignee": {}, "riskScoreMap": {"key": "value"}, "args": {"key": "value"}, "target": {}, "cls": "example-cls", "id": "abc-12345", "name": "Example Item", "dest": {"key": "value"}, "targetIdentity": {}, "loggedInUser": {}, "cert": {}, "selfCertificationChecker": {}, "certItem": {}, "itemToCheck": [{}], "svc": {}, "identityId": "abc-12345", "identityName": "Example Identity", "targetIdentityDTO": {}, "displayName": "Example Display", "vrDTO": {}, "violations": [{}], "wi": {}, "comment": "example-comment", "rejectedIds": ["example-value"], "set": {}, "approvals": [{}], "nextWorkItem": {}, "nextWorkItemDTO": {}, "raService": {}, "submitResultItem": {}, "session": {}, "reattachedItem": {}, "wfcase": {}, "workflower": {}, "approvalSet": {}, "attachmentDTOs": [{}], "qo": {}, "filters": [{}], "attachments": [{}]}, "navigationUtil": {"workItem": {}, "nav": "example-nav", "wiaop": {}, "wia": {}, "arch": {}, "workItemId": "abc-12345", "next": "example-next"}, "notary": {"locale": {}, "config": {}, "item": {}, "cert": {}, "text": "Example message text", "type": "ExampleType", "localized": "example-localized", "meanings": {"key": "value"}, "sigs": [{}], "accountId": "abc-12345", "password": "**hidden**", "samlNameId": "abc-12345", "samlAssertionId": "abc-12345", "ident": {}, "authApp": "Example Application", "esig": {}, "eSig": {}, "auth": {}, "o": "example-o", "iiqDefault": "example-iiqDefault"}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
patch:
operationId: ui_ApprovalWorkItemResource_patch
tags:
- UI Approvals
summary: Set values on the work item from the values map
description: Set values on the work item from the values map
parameters:
- in: path
name: workItemId
required: true
description: The workItemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/approvals/{workItemId}/approveAll':
post:
operationId: ui_ApprovalWorkItemResource_approveAllItems
tags:
- UI Approvals
summary: Approve all approval items
description: Approve all approval items
parameters:
- in: path
name: workItemId
required: true
description: The workItemId path parameter.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"targetIdentity": "abc-12345", "workItemState": "Active"}
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/approvals/{workItemId}/assign':
post:
operationId: ui_ApprovalWorkItemResource_assign
tags:
- UI Approvals
summary: Assign approval work item to new workgroup member
description: Assign approval work item to new workgroup member
parameters:
- in: path
name: workItemId
required: true
description: The workItemId path parameter.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"targetIdentity": "abc-12345"}
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/approvals/{workItemId}/comments':
get:
operationId: ui_ApprovalWorkItemResource_getComments
tags:
- UI Approvals
summary: 'Return a list containing the comments for this approval work item, with each list entry containing: - author: The displayable name of the comment author'
description: 'Return a list containing the comments for this approval work item, with each list entry containing: - author: The displayable name of the comment author'
parameters:
- in: path
name: workItemId
required: true
description: The workItemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: array
items:
type: object
example: [{"id": "12345", "name": "Example Item", "description": "Sample record"}]
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: ui_ApprovalWorkItemResource_addComment
tags:
- UI Approvals
summary: Add a comment to this approval work item and send notifications
description: Add a comment to this approval work item and send notifications
parameters:
- in: path
name: workItemId
required: true
description: The workItemId path parameter.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"targetIdentity": "abc-12345", "workItemState": "Active"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"targetIdentity": "abc-12345", "workItemState": "Active"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/approvals/{workItemId}/complete':
post:
operationId: ui_ApprovalWorkItemResource_complete
tags:
- UI Approvals
summary: Complete the approval work item
description: Complete the approval work item
parameters:
- in: path
name: workItemId
required: true
description: The workItemId path parameter.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"workItemState": "Active"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: WorkItemResult
example: {"nextWorkItemId": "abc-12345", "cancelled": true, "returnPage": "example-returnPage", "messages": [{"messageOrKey": "example-messageOrKey", "status": "Active", "type": "ExampleType", "args": ["example-value"]}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/approvals/{workItemId}/items/{itemId}':
patch:
operationId: ui_ApprovalItemResource_patchApprovalItem
tags:
- UI Approvals
summary: Patch values on the approval item
description: Patch values on the approval item
parameters:
- in: path
name: workItemId
required: true
description: The workItemId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/approvals/{workItemId}/items/{itemId}/approve':
post:
operationId: ui_ApprovalItemResource_approveItem
tags:
- UI Approvals
summary: Approve a single approval item
description: Approve a single approval item
parameters:
- in: path
name: workItemId
required: true
description: The workItemId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"account": 25, "application": "Example Application", "role": "example-role"}
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/approvals/{workItemId}/items/{itemId}/comments':
get:
operationId: ui_ApprovalItemResource_getItemComments
tags:
- UI Approvals
summary: Get the comments (include the requester comment) for the requested approval item
description: Get the comments (include the requester comment) for the requested approval item
parameters:
- in: path
name: workItemId
required: true
description: The workItemId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: array
items:
type: object
example: [{"id": "12345", "name": "Example Item", "description": "Sample record"}]
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: ui_ApprovalItemResource_addItemComment
tags:
- UI Approvals
summary: Add a comment to the given approval item and send notifications
description: Add a comment to the given approval item and send notifications
parameters:
- in: path
name: workItemId
required: true
description: The workItemId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"account": 25, "application": "Example Application", "role": "example-role"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"account": 25, "application": "Example Application", "role": "example-role"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/approvals/{workItemId}/items/{itemId}/managedAttributeDetails':
get:
operationId: ui_ManagedAttributeDetailResource_getDetails
tags:
- Managed Attributes
summary: Get the details for the managed attribute
description: Get the details for the managed attribute
parameters:
- in: path
name: workItemId
required: true
description: The workItemId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: ManagedAttributeDetailDTO
example: {"id": "abc-12345", "application": "Example Application", "type": "ExampleType", "attribute": "example-attribute", "value": "example-value", "displayValue": "example-displayValue", "description": "A brief description.", "owner": "jsmith", "requestable": true, "iiqElevatedAccess": true, "extendedAttributes": {"key": "value"}, "groupAttributes": {"key": "value"}, "groupEntitlements": [{"nativeIdentity": "example-nativeIdentity", "accountName": "Example Account", "assigned": true, "grantedByRole": true, "startDate": "2024-01-01T00:00:00Z", "endDate": "2024-01-01T00:00:00Z", "lastCertDate": "2024-01-01T00:00:00Z", "lastCertName": "Example Lastcert", "lastCertificationItem": {}, "pendingCertificationItem": {}, "lastRequestItem": {}, "pendingRequestItem": {}, "assigner": "example-assigner", "source": "example-source", "foundOnAccount": true, "detectedRole": true, "hasPendingRequest": true, "pendingRequestId": "abc-12345", "allowed": true, "entitlementRequireEndDateTime": true, "entitlementMaxAccessTimeEnabled": true, "entitlementMaxAccessTimeValue": 0, "entitlementMaxAccessTimeUnit": "example-entitlementMaxAccessTimeUnit", "sourceAssignableRoleNames": ["example-value"], "sourceDetectableRoleNames": ["example-value"], "lastItem": {}, "pendingItem": {}}], "hasInheritance": true, "hasAccess": true, "hasMembers": true, "hasClassifications": true, "hasCloudAccess": true, "hasRoles": true}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/approvals/{workItemId}/items/{itemId}/managedAttributeDetails/access':
get:
operationId: ui_TargetAssociationListResource_getAssociations
tags:
- Managed Attributes
summary: Get associations
description: Get associations
parameters:
- in: path
name: workItemId
required: true
description: The workItemId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/approvals/{workItemId}/items/{itemId}/managedAttributeDetails/cam/group':
get:
operationId: ui_ManagedAttributeDetailResource_getGroup
tags:
- Managed Attributes
summary: Gets the sub resource for getting the CAM group details for this managed attribute
description: Gets the sub resource for getting the CAM group details for this managed attribute
parameters:
- in: path
name: workItemId
required: true
description: The workItemId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: CAMGroupDTO
example: {"errors": ["example-value"], "roles": [{"nativeId": "abc-12345", "cspType": "ExampleType", "displayName": "Example Display", "uri": "https://example.sailpoint.com", "adminCount": 1, "writeCount": 1, "readCount": 1, "scopes": [{}], "errors": ["example-value"], "camScopeDTO": {}}], "services": [{"name": "Example Item", "type": "ExampleType", "numResources": 0}], "uri": "https://example.sailpoint.com", "cspType": "ExampleType", "nativeId": "abc-12345", "displayName": "Example Display", "rolesList": {"items": [{}], "federatedRolesList": {}, "sb": {}}, "servicesList": {"items": [{}], "servicesList": {}, "sb": {}}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/approvals/{workItemId}/items/{itemId}/managedAttributeDetails/cam/scope':
get:
operationId: ui_ManagedAttributeDetailResource_getScopeServices
tags:
- Managed Attributes
summary: Gets the sub resource for getting the CAM details for this managed attribute
description: Gets the sub resource for getting the CAM details for this managed attribute
parameters:
- in: path
name: workItemId
required: true
description: The workItemId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: query
name: uri
required: false
description: The uri query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/approvals/{workItemId}/items/{itemId}/managedAttributeDetails/cam/service':
get:
operationId: ui_CAMResourcesListResource_getServiceResources
tags:
- UI CAM
summary: Get the list of CAM resources
description: Get the list of CAM resources
parameters:
- in: path
name: workItemId
required: true
description: The workItemId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/approvals/{workItemId}/items/{itemId}/managedAttributeDetails/classifications':
get:
operationId: ui_ClassificationListResource_getClassifications
tags:
- Managed Attributes
summary: Public GET method to retrieve a ListResult of ClassificationDTOs
description: Public GET method to retrieve a ListResult of ClassificationDTOs
parameters:
- in: path
name: workItemId
required: true
description: The workItemId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/approvals/{workItemId}/items/{itemId}/managedAttributeDetails/inheritance/children':
get:
operationId: ui_ManagedAttributeInheritanceListResource_getChildren
tags:
- Managed Attributes
summary: Gets the children managed attributes based on inheritance
description: Gets the children managed attributes based on inheritance
parameters:
- in: path
name: workItemId
required: true
description: The workItemId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/approvals/{workItemId}/items/{itemId}/managedAttributeDetails/inheritance/parents':
get:
operationId: ui_ManagedAttributeInheritanceListResource_getParents
tags:
- Managed Attributes
summary: Gets the parent managed attributes based on inheritance
description: Gets the parent managed attributes based on inheritance
parameters:
- in: path
name: workItemId
required: true
description: The workItemId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/approvals/{workItemId}/items/{itemId}/managedAttributeDetails/members':
get:
operationId: ui_AccountGroupMemberListResource_getMembers
tags:
- UI Me
summary: Get the list of account group members
description: Get the list of account group members
parameters:
- in: path
name: workItemId
required: true
description: The workItemId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/approvals/{workItemId}/items/{itemId}/managedAttributeDetails/roles':
get:
operationId: ui_AccountGroupRolesListResource_getRoles
tags:
- UI Approvals
summary: Get the list of associated roles for ManagedAttribute
description: Get the list of associated roles for ManagedAttribute
parameters:
- in: path
name: workItemId
required: true
description: The workItemId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/approvals/{workItemId}/items/{itemId}/reject':
post:
operationId: ui_ApprovalItemResource_rejectItem
tags:
- UI Approvals
summary: Reject a single approval item
description: Reject a single approval item
parameters:
- in: path
name: workItemId
required: true
description: The workItemId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"account": 25, "application": "Example Application", "role": "example-role"}
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/approvals/{workItemId}/items/{itemId}/roleDetails':
get:
operationId: ui_RoleDetailResource_getDetails
tags:
- Roles
summary: Get a RoleDetailDTO to represent to current role
description: Get a RoleDetailDTO to represent to current role
parameters:
- in: path
name: workItemId
required: true
description: The workItemId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: RoleDetailDTO
example: {"id": "abc-12345", "identityId": "abc-12345", "identityDisplayName": "Example Identitydisplay", "assignmentId": "abc-12345", "identityHasRole": true, "assigned": true, "detected": true, "displayName": "Example Display", "type": "ExampleType", "typeIcon": "example-typeIcon", "owner": {"id": "abc-12345", "name": "Example Item", "displayName": "Example Display"}, "description": "A brief description.", "iiqElevatedAccess": true, "permittedBy": "example-permittedBy", "assignmentNote": "example-assignmentNote", "accountDetails": [{"value": "example-value", "application": "Example Application", "account": 1, "nativeIdentity": "example-nativeIdentity", "sourceRole": "example-sourceRole", "iiqElevatedAccess": true}], "contributingEntitlements": [{"nativeIdentity": "example-nativeIdentity", "accountName": "Example Account", "assigned": true, "grantedByRole": true, "startDate": "2024-01-01T00:00:00Z", "endDate": "2024-01-01T00:00:00Z", "lastCertDate": "2024-01-01T00:00:00Z", "lastCertName": "Example Lastcert", "lastCertificationItem": {}, "pendingCertificationItem": {}, "lastRequestItem": {}, "pendingRequestItem": {}, "assigner": "example-assigner", "source": "example-source", "foundOnAccount": true, "detectedRole": true, "hasPendingRequest": true, "pendingRequestId": "abc-12345", "allowed": true, "entitlementRequireEndDateTime": true, "entitlementMaxAccessTimeEnabled": true, "entitlementMaxAccessTimeValue": 0, "entitlementMaxAccessTimeUnit": "example-entitlementMaxAccessTimeUnit", "sourceAssignableRoleNames": ["example-value"], "sourceDetectableRoleNames": ["example-value"], "lastItem": {}, "pendingItem": {}}], "permittedRoles": [{}], "requiredRoles": [{}], "hierarchy": [{}], "hasHierarchy": true, "classificationNames": ["example-value"], "profiles": [{"name": "Example Item", "application": "Example Application", "iiqElevatedAccess": true, "constraints": ["example-value"], "permissions": [{}], "entitlements": [{}]}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/approvals/{workItemId}/items/{itemId}/roleDetails/classifications':
get:
operationId: ui_ClassificationListResource_getClassifications_2
tags:
- Managed Attributes
summary: Public GET method to retrieve a ListResult of ClassificationDTOs
description: Public GET method to retrieve a ListResult of ClassificationDTOs
parameters:
- in: path
name: workItemId
required: true
description: The workItemId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/approvals/{workItemId}/items/{itemId}/roleDetails/simpleEntitlements':
get:
operationId: ui_RoleDetailResource_getSimpleEntitlements
tags:
- Roles
summary: Returns a list of simple entitlements on the specified role
description: Returns a list of simple entitlements on the specified role
parameters:
- in: path
name: workItemId
required: true
description: The workItemId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/approvals/{workItemId}/items/{itemId}/roleDetails/{managedAttributeId}/managedAttributeDetails':
get:
operationId: ui_ManagedAttributeDetailResource_getDetails_2
tags:
- Managed Attributes
summary: Get the details for the managed attribute
description: Get the details for the managed attribute
parameters:
- in: path
name: workItemId
required: true
description: The workItemId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: ManagedAttributeDetailDTO
example: {"id": "abc-12345", "application": "Example Application", "type": "ExampleType", "attribute": "example-attribute", "value": "example-value", "displayValue": "example-displayValue", "description": "A brief description.", "owner": "jsmith", "requestable": true, "iiqElevatedAccess": true, "extendedAttributes": {"key": "value"}, "groupAttributes": {"key": "value"}, "groupEntitlements": [{"nativeIdentity": "example-nativeIdentity", "accountName": "Example Account", "assigned": true, "grantedByRole": true, "startDate": "2024-01-01T00:00:00Z", "endDate": "2024-01-01T00:00:00Z", "lastCertDate": "2024-01-01T00:00:00Z", "lastCertName": "Example Lastcert", "lastCertificationItem": {}, "pendingCertificationItem": {}, "lastRequestItem": {}, "pendingRequestItem": {}, "assigner": "example-assigner", "source": "example-source", "foundOnAccount": true, "detectedRole": true, "hasPendingRequest": true, "pendingRequestId": "abc-12345", "allowed": true, "entitlementRequireEndDateTime": true, "entitlementMaxAccessTimeEnabled": true, "entitlementMaxAccessTimeValue": 0, "entitlementMaxAccessTimeUnit": "example-entitlementMaxAccessTimeUnit", "sourceAssignableRoleNames": ["example-value"], "sourceDetectableRoleNames": ["example-value"], "lastItem": {}, "pendingItem": {}}], "hasInheritance": true, "hasAccess": true, "hasMembers": true, "hasClassifications": true, "hasCloudAccess": true, "hasRoles": true}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/approvals/{workItemId}/items/{itemId}/roleDetails/{managedAttributeId}/managedAttributeDetails/access':
get:
operationId: ui_TargetAssociationListResource_getAssociations_2
tags:
- Managed Attributes
summary: Get associations
description: Get associations
parameters:
- in: path
name: workItemId
required: true
description: The workItemId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/approvals/{workItemId}/items/{itemId}/roleDetails/{managedAttributeId}/managedAttributeDetails/cam/group':
get:
operationId: ui_ManagedAttributeDetailResource_getGroup_2
tags:
- Managed Attributes
summary: Gets the sub resource for getting the CAM group details for this managed attribute
description: Gets the sub resource for getting the CAM group details for this managed attribute
parameters:
- in: path
name: workItemId
required: true
description: The workItemId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: CAMGroupDTO
example: {"errors": ["example-value"], "roles": [{"nativeId": "abc-12345", "cspType": "ExampleType", "displayName": "Example Display", "uri": "https://example.sailpoint.com", "adminCount": 1, "writeCount": 1, "readCount": 1, "scopes": [{}], "errors": ["example-value"], "camScopeDTO": {}}], "services": [{"name": "Example Item", "type": "ExampleType", "numResources": 0}], "uri": "https://example.sailpoint.com", "cspType": "ExampleType", "nativeId": "abc-12345", "displayName": "Example Display", "rolesList": {"items": [{}], "federatedRolesList": {}, "sb": {}}, "servicesList": {"items": [{}], "servicesList": {}, "sb": {}}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/approvals/{workItemId}/items/{itemId}/roleDetails/{managedAttributeId}/managedAttributeDetails/cam/scope':
get:
operationId: ui_ManagedAttributeDetailResource_getScopeServices_2
tags:
- Managed Attributes
summary: Gets the sub resource for getting the CAM details for this managed attribute
description: Gets the sub resource for getting the CAM details for this managed attribute
parameters:
- in: path
name: workItemId
required: true
description: The workItemId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
- in: query
name: uri
required: false
description: The uri query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/approvals/{workItemId}/items/{itemId}/roleDetails/{managedAttributeId}/managedAttributeDetails/cam/service':
get:
operationId: ui_CAMResourcesListResource_getServiceResources_2
tags:
- UI CAM
summary: Get the list of CAM resources
description: Get the list of CAM resources
parameters:
- in: path
name: workItemId
required: true
description: The workItemId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/approvals/{workItemId}/items/{itemId}/roleDetails/{managedAttributeId}/managedAttributeDetails/classifications':
get:
operationId: ui_ClassificationListResource_getClassifications_3
tags:
- Managed Attributes
summary: Public GET method to retrieve a ListResult of ClassificationDTOs
description: Public GET method to retrieve a ListResult of ClassificationDTOs
parameters:
- in: path
name: workItemId
required: true
description: The workItemId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/approvals/{workItemId}/items/{itemId}/roleDetails/{managedAttributeId}/managedAttributeDetails/inheritance/children':
get:
operationId: ui_ManagedAttributeInheritanceListResource_getChildren_2
tags:
- Managed Attributes
summary: Gets the children managed attributes based on inheritance
description: Gets the children managed attributes based on inheritance
parameters:
- in: path
name: workItemId
required: true
description: The workItemId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/approvals/{workItemId}/items/{itemId}/roleDetails/{managedAttributeId}/managedAttributeDetails/inheritance/parents':
get:
operationId: ui_ManagedAttributeInheritanceListResource_getParents_2
tags:
- Managed Attributes
summary: Gets the parent managed attributes based on inheritance
description: Gets the parent managed attributes based on inheritance
parameters:
- in: path
name: workItemId
required: true
description: The workItemId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/approvals/{workItemId}/items/{itemId}/roleDetails/{managedAttributeId}/managedAttributeDetails/members':
get:
operationId: ui_AccountGroupMemberListResource_getMembers_2
tags:
- UI Me
summary: Get the list of account group members
description: Get the list of account group members
parameters:
- in: path
name: workItemId
required: true
description: The workItemId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/approvals/{workItemId}/items/{itemId}/roleDetails/{managedAttributeId}/managedAttributeDetails/roles':
get:
operationId: ui_AccountGroupRolesListResource_getRoles_2
tags:
- UI Approvals
summary: Get the list of associated roles for ManagedAttribute
description: Get the list of associated roles for ManagedAttribute
parameters:
- in: path
name: workItemId
required: true
description: The workItemId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/approvals/{workItemId}/items/{itemId}/roleDetails/{subRoleId}/hierarchy':
get:
operationId: ui_RoleDetailResource_getHierarchy
tags:
- Roles
summary: Get a list of RoleDetailDTOs to represent the next level of hierarchy for the given sub role
description: Get a list of RoleDetailDTOs to represent the next level of hierarchy for the given sub role
parameters:
- in: path
name: workItemId
required: true
description: The workItemId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: subRoleId
required: true
description: The subRoleId.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: array
items:
type: object
example: [{"id": "12345", "name": "Example Item", "description": "Sample record"}]
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/approvals/{workItemId}/items/{itemId}/simpleEntitlements':
get:
operationId: ui_ApprovalItemResource_getSimpleEntitlements
tags:
- UI Approvals
summary: Gets the simple entitlements associated with the role in the approval item
description: Gets the simple entitlements associated with the role in the approval item
parameters:
- in: path
name: workItemId
required: true
description: The workItemId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/approvals/{workItemId}/items/{itemId}/targetAccounts':
get:
operationId: ui_ApprovalItemResource_getTargetAccounts
tags:
- UI Approvals
summary: Get target account details for role approvals
description: Get target account details for role approvals
parameters:
- in: path
name: workItemId
required: true
description: The workItemId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: array
items:
type: object
example: [{"id": "12345", "name": "Example Item", "description": "Sample record"}]
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/approvals/{workItemId}/items/{itemId}/undo':
post:
operationId: ui_ApprovalItemResource_undoItem
tags:
- UI Approvals
summary: Undo decision on a single approval item
description: Undo decision on a single approval item
parameters:
- in: path
name: workItemId
required: true
description: The workItemId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/approvals/{workItemId}/rejectAll':
post:
operationId: ui_ApprovalWorkItemResource_rejectAllItems
tags:
- UI Approvals
summary: Reject all approval items
description: Reject all approval items
parameters:
- in: path
name: workItemId
required: true
description: The workItemId path parameter.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"targetIdentity": "abc-12345", "workItemState": "Active"}
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/attachment:
post:
operationId: ui_AccessRequestConfigResource_getAttachmentConfigs
tags:
- UI Access Request Config
summary: Get the attachment configs for the request
description: Get the attachment configs for the request
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"type": "ExampleType", "items": "example-items"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"type": "ExampleType", "items": "example-items"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/batchRequests/{batchRequestId}/items':
get:
operationId: ui_BatchRequestItemsListResource_getBatchRequestItems
tags:
- UI Batch Requests
summary: Get batch request items
description: Get batch request items
parameters:
- in: path
name: batchRequestId
required: true
description: The batchRequestId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule:
get:
operationId: ui_CertificationScheduleResource_getCertSchedule
tags:
- UI Certifications
summary: Gets a single certificationScheduleDTO based off of a task schedule id or certification group id
description: Gets a single certificationScheduleDTO based off of a task schedule id or certification group id
parameters:
- in: query
name: taskScheduleId
required: false
description: The taskScheduleId query parameter.
schema:
type: string
- in: query
name: certificationGroupId
required: false
description: The certificationGroupId query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
object:
type: object
description: The returned object
example: {"object": {"id": "abc-12345", "name": "Example Item"}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: ui_CertificationScheduleResource_saveCertDefinition
tags:
- UI Certifications
summary: Saves a CertificationDefinition object based on the passed in DTO from the client
description: Saves a CertificationDefinition object based on the passed in DTO from the client
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"definition": {}, "name": "Example Item", "certificationGroupId": "abc-12345", "certificationGroupName": "Example Certificationgroup", "taskId": "abc-12345", "firstExecution": "example-firstExecution", "activated": "example-activated", "frequency": "example-frequency", "runNow": true}
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/accountFilters:
get:
operationId: ui_CertificationScheduleResource_getAccountFilters
tags:
- UI Certifications
summary: Gets the filters for the certification schedule UI for Accounts
description: Gets the filters for the certification schedule UI for Accounts
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: array
items:
type: object
example: [{"id": "12345", "name": "Example Item", "description": "Sample record"}]
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/accountFiltersSuggest/suggest/activityDataSourceTypes:
get:
operationId: ui_SuggestResource_getActivityDataSourceTypesSuggest_6
tags:
- UI Suggest
summary: This endpoint returns List of ActivityDataSourceTypes
description: This endpoint returns List of ActivityDataSourceTypes
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/accountFiltersSuggest/suggest/applicationAttributes:
get:
operationId: ui_SuggestResource_getApplicationAttributes_6
tags:
- UI Suggest
summary: Returns data for ApplicationAttributes dropdown in Application Definition screen
description: Returns data for ApplicationAttributes dropdown in Application Definition screen
parameters:
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appName
required: false
description: The appName query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/accountFiltersSuggest/suggest/applications:
get:
operationId: ui_ApplicationSuggestResource_getApplications_6
tags:
- UI Suggest
summary: List of application maps for all applications
description: List of application maps for all applications
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/accountFiltersSuggest/suggest/applications/attributeValues:
post:
operationId: ui_ApplicationSuggestResource_getAttributeValues_6
tags:
- UI Suggest
summary: List of values for the given list of application and attribute
description: List of values for the given list of application and attribute
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"applications": "Example Application", "attributes": ["id", "name", "description"], "limit": 25, "query": "name sw \"example\"", "start": 0}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certificationSchedule/accountFiltersSuggest/suggest/column/{class}/{column}':
get:
operationId: ui_SuggestResource_getColumnSuggestViaHttpGet_6
tags:
- UI Suggest
summary: Returns a list of results for a suggest containing distinct column values on a given class type
description: Returns a list of results for a suggest containing distinct column values on a given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
- in: path
name: column
required: true
description: The column.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: ui_SuggestResource_getColumnSuggestViaHttpPost_6
tags:
- UI Suggest
summary: Returns a list of results for a suggest containing distinct column values on a given class type
description: Returns a list of results for a suggest containing distinct column values on a given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
- in: path
name: column
required: true
description: The column.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"displayName": "Example Name", "value": "example-value"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/accountFiltersSuggest/suggest/identityAttributes:
get:
operationId: ui_SuggestResource_getIdentityAttributes_6
tags:
- UI Suggest
summary: Returns data for IdentityAttributes dropdown in Application Definition Screen
description: Returns data for IdentityAttributes dropdown in Application Definition Screen
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certificationSchedule/accountFiltersSuggest/suggest/object/{class}':
get:
operationId: ui_SuggestResource_getSuggestViaHttpGet_6
tags:
- UI Suggest
summary: Returns a json data feed for a suggest component for the given class type
description: Returns a json data feed for a suggest component for the given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: ui_SuggestResource_getSuggestViaHttpPost_6
tags:
- UI Suggest
summary: Returns a json data feed for a suggest component for the given class type
description: Returns a json data feed for a suggest component for the given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"displayName": "Example Name", "value": "example-value"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/accountFiltersSuggest/suggest/operators:
get:
operationId: ui_SuggestResource_getOperators_6
tags:
- UI Suggest
summary: 'Returns Operators for dropdown in ConditionBasedCorrelation -> Correlation tab'
description: 'Returns Operators for dropdown in ConditionBasedCorrelation -> Correlation tab'
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/accountFiltersSuggest/suggest/provisioningActions:
get:
operationId: ui_SuggestResource_getProvisioningActionSuggest_6
tags:
- UI Suggest
summary: This endpoint returns list of provisioning actions in unstructured target page
description: This endpoint returns list of provisioning actions in unstructured target page
parameters:
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
- in: query
name: targetSourceType
required: false
description: The targetSourceType query parameter.
schema:
type: string
- in: query
name: provisioningOverridden
required: false
description: The provisioningOverridden query parameter.
schema:
type: boolean
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/accountFiltersSuggest/suggest/targetSourceTypes:
get:
operationId: ui_SuggestResource_getTargetSourceTypesSuggest_6
tags:
- UI Suggest
summary: This endpoint returns List of TargetSourceTypes corresponding to application type inside unstructured targets tab in the functionality of add/edit application
description: This endpoint returns List of TargetSourceTypes corresponding to application type inside unstructured targets tab in the functionality of add/edit application
parameters:
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/accountFiltersSuggest/suggest/targetSources:
get:
operationId: ui_SuggestResource_getTargetSourcesSuggest_6
tags:
- UI Suggest
summary: This endpoint returns List of TargetSources which are relevant for the application corresponding to application type inside unstructured targets tab in the functionality of add/edit application
description: This endpoint returns List of TargetSources which are relevant for the application corresponding to application type inside unstructured targets tab in the functionality of add/edit application
parameters:
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/additionalEntitlementsFilters:
get:
operationId: ui_CertificationScheduleResource_getAdditionalEntitlementsFilters
tags:
- UI Certifications
summary: Gets the filters for the certification schedule UI for Additional Entitlements
description: Gets the filters for the certification schedule UI for Additional Entitlements
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: array
items:
type: object
example: [{"id": "12345", "name": "Example Item", "description": "Sample record"}]
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/additionalEntitlementsFiltersSuggest/suggest/activityDataSourceTypes:
get:
operationId: ui_SuggestResource_getActivityDataSourceTypesSuggest_7
tags:
- UI Suggest
summary: This endpoint returns List of ActivityDataSourceTypes
description: This endpoint returns List of ActivityDataSourceTypes
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/additionalEntitlementsFiltersSuggest/suggest/applicationAttributes:
get:
operationId: ui_SuggestResource_getApplicationAttributes_7
tags:
- UI Suggest
summary: Returns data for ApplicationAttributes dropdown in Application Definition screen
description: Returns data for ApplicationAttributes dropdown in Application Definition screen
parameters:
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appName
required: false
description: The appName query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/additionalEntitlementsFiltersSuggest/suggest/applications:
get:
operationId: ui_ApplicationSuggestResource_getApplications_7
tags:
- UI Suggest
summary: List of application maps for all applications
description: List of application maps for all applications
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/additionalEntitlementsFiltersSuggest/suggest/applications/attributeValues:
post:
operationId: ui_ApplicationSuggestResource_getAttributeValues_7
tags:
- UI Suggest
summary: List of values for the given list of application and attribute
description: List of values for the given list of application and attribute
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"applications": "Example Application", "attributes": ["id", "name", "description"], "limit": 25, "query": "name sw \"example\"", "start": 0}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certificationSchedule/additionalEntitlementsFiltersSuggest/suggest/column/{class}/{column}':
get:
operationId: ui_SuggestResource_getColumnSuggestViaHttpGet_7
tags:
- UI Suggest
summary: Returns a list of results for a suggest containing distinct column values on a given class type
description: Returns a list of results for a suggest containing distinct column values on a given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
- in: path
name: column
required: true
description: The column.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: ui_SuggestResource_getColumnSuggestViaHttpPost_7
tags:
- UI Suggest
summary: Returns a list of results for a suggest containing distinct column values on a given class type
description: Returns a list of results for a suggest containing distinct column values on a given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
- in: path
name: column
required: true
description: The column.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"displayName": "Example Name", "value": "example-value"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/additionalEntitlementsFiltersSuggest/suggest/identityAttributes:
get:
operationId: ui_SuggestResource_getIdentityAttributes_7
tags:
- UI Suggest
summary: Returns data for IdentityAttributes dropdown in Application Definition Screen
description: Returns data for IdentityAttributes dropdown in Application Definition Screen
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certificationSchedule/additionalEntitlementsFiltersSuggest/suggest/object/{class}':
get:
operationId: ui_SuggestResource_getSuggestViaHttpGet_7
tags:
- UI Suggest
summary: Returns a json data feed for a suggest component for the given class type
description: Returns a json data feed for a suggest component for the given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: ui_SuggestResource_getSuggestViaHttpPost_7
tags:
- UI Suggest
summary: Returns a json data feed for a suggest component for the given class type
description: Returns a json data feed for a suggest component for the given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"displayName": "Example Name", "value": "example-value"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/additionalEntitlementsFiltersSuggest/suggest/operators:
get:
operationId: ui_SuggestResource_getOperators_7
tags:
- UI Suggest
summary: 'Returns Operators for dropdown in ConditionBasedCorrelation -> Correlation tab'
description: 'Returns Operators for dropdown in ConditionBasedCorrelation -> Correlation tab'
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/additionalEntitlementsFiltersSuggest/suggest/provisioningActions:
get:
operationId: ui_SuggestResource_getProvisioningActionSuggest_7
tags:
- UI Suggest
summary: This endpoint returns list of provisioning actions in unstructured target page
description: This endpoint returns list of provisioning actions in unstructured target page
parameters:
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
- in: query
name: targetSourceType
required: false
description: The targetSourceType query parameter.
schema:
type: string
- in: query
name: provisioningOverridden
required: false
description: The provisioningOverridden query parameter.
schema:
type: boolean
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/additionalEntitlementsFiltersSuggest/suggest/targetSourceTypes:
get:
operationId: ui_SuggestResource_getTargetSourceTypesSuggest_7
tags:
- UI Suggest
summary: This endpoint returns List of TargetSourceTypes corresponding to application type inside unstructured targets tab in the functionality of add/edit application
description: This endpoint returns List of TargetSourceTypes corresponding to application type inside unstructured targets tab in the functionality of add/edit application
parameters:
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/additionalEntitlementsFiltersSuggest/suggest/targetSources:
get:
operationId: ui_SuggestResource_getTargetSourcesSuggest_7
tags:
- UI Suggest
summary: This endpoint returns List of TargetSources which are relevant for the application corresponding to application type inside unstructured targets tab in the functionality of add/edit application
description: This endpoint returns List of TargetSources which are relevant for the application corresponding to application type inside unstructured targets tab in the functionality of add/edit application
parameters:
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/identityFilters:
get:
operationId: ui_CertificationScheduleResource_getIdentityFilters
tags:
- UI Certifications
summary: Get the available filters for identities
description: Get the available filters for identities
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: array
items:
type: object
example: [{"id": "12345", "name": "Example Item", "description": "Sample record"}]
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/identityFiltersSuggest/suggest/activityDataSourceTypes:
get:
operationId: ui_SuggestResource_getActivityDataSourceTypesSuggest_8
tags:
- UI Suggest
summary: This endpoint returns List of ActivityDataSourceTypes
description: This endpoint returns List of ActivityDataSourceTypes
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/identityFiltersSuggest/suggest/applicationAttributes:
get:
operationId: ui_SuggestResource_getApplicationAttributes_8
tags:
- UI Suggest
summary: Returns data for ApplicationAttributes dropdown in Application Definition screen
description: Returns data for ApplicationAttributes dropdown in Application Definition screen
parameters:
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appName
required: false
description: The appName query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/identityFiltersSuggest/suggest/applications:
get:
operationId: ui_ApplicationSuggestResource_getApplications_8
tags:
- UI Suggest
summary: List of application maps for all applications
description: List of application maps for all applications
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/identityFiltersSuggest/suggest/applications/attributeValues:
post:
operationId: ui_ApplicationSuggestResource_getAttributeValues_8
tags:
- UI Suggest
summary: List of values for the given list of application and attribute
description: List of values for the given list of application and attribute
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"applications": "Example Application", "attributes": ["id", "name", "description"], "limit": 25, "query": "name sw \"example\"", "start": 0}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certificationSchedule/identityFiltersSuggest/suggest/column/{class}/{column}':
get:
operationId: ui_SuggestResource_getColumnSuggestViaHttpGet_8
tags:
- UI Suggest
summary: Returns a list of results for a suggest containing distinct column values on a given class type
description: Returns a list of results for a suggest containing distinct column values on a given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
- in: path
name: column
required: true
description: The column.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: ui_SuggestResource_getColumnSuggestViaHttpPost_8
tags:
- UI Suggest
summary: Returns a list of results for a suggest containing distinct column values on a given class type
description: Returns a list of results for a suggest containing distinct column values on a given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
- in: path
name: column
required: true
description: The column.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"displayName": "Example Name", "value": "example-value"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/identityFiltersSuggest/suggest/identityAttributes:
get:
operationId: ui_SuggestResource_getIdentityAttributes_8
tags:
- UI Suggest
summary: Returns data for IdentityAttributes dropdown in Application Definition Screen
description: Returns data for IdentityAttributes dropdown in Application Definition Screen
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certificationSchedule/identityFiltersSuggest/suggest/object/{class}':
get:
operationId: ui_SuggestResource_getSuggestViaHttpGet_8
tags:
- UI Suggest
summary: Returns a json data feed for a suggest component for the given class type
description: Returns a json data feed for a suggest component for the given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: ui_SuggestResource_getSuggestViaHttpPost_8
tags:
- UI Suggest
summary: Returns a json data feed for a suggest component for the given class type
description: Returns a json data feed for a suggest component for the given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"displayName": "Example Name", "value": "example-value"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/identityFiltersSuggest/suggest/operators:
get:
operationId: ui_SuggestResource_getOperators_8
tags:
- UI Suggest
summary: 'Returns Operators for dropdown in ConditionBasedCorrelation -> Correlation tab'
description: 'Returns Operators for dropdown in ConditionBasedCorrelation -> Correlation tab'
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/identityFiltersSuggest/suggest/provisioningActions:
get:
operationId: ui_SuggestResource_getProvisioningActionSuggest_8
tags:
- UI Suggest
summary: This endpoint returns list of provisioning actions in unstructured target page
description: This endpoint returns list of provisioning actions in unstructured target page
parameters:
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
- in: query
name: targetSourceType
required: false
description: The targetSourceType query parameter.
schema:
type: string
- in: query
name: provisioningOverridden
required: false
description: The provisioningOverridden query parameter.
schema:
type: boolean
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/identityFiltersSuggest/suggest/targetSourceTypes:
get:
operationId: ui_SuggestResource_getTargetSourceTypesSuggest_8
tags:
- UI Suggest
summary: This endpoint returns List of TargetSourceTypes corresponding to application type inside unstructured targets tab in the functionality of add/edit application
description: This endpoint returns List of TargetSourceTypes corresponding to application type inside unstructured targets tab in the functionality of add/edit application
parameters:
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/identityFiltersSuggest/suggest/targetSources:
get:
operationId: ui_SuggestResource_getTargetSourcesSuggest_8
tags:
- UI Suggest
summary: This endpoint returns List of TargetSources which are relevant for the application corresponding to application type inside unstructured targets tab in the functionality of add/edit application
description: This endpoint returns List of TargetSources which are relevant for the application corresponding to application type inside unstructured targets tab in the functionality of add/edit application
parameters:
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/new:
get:
operationId: ui_CertificationScheduleResource_getNewCertSchedule
tags:
- UI Certifications
summary: 'Gets a new CertificationScheduleDTO either based on system defaults, or based on an existing certification group ID'
description: 'Gets a new CertificationScheduleDTO either based on system defaults, or based on an existing certification group ID'
parameters:
- in: query
name: certificationGroupId
required: false
description: The certificationGroupId query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
object:
type: object
description: The returned object
example: {"object": {"id": "abc-12345", "name": "Example Item"}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/roleFilters:
get:
operationId: ui_CertificationScheduleResource_getRoleFilters
tags:
- UI Certifications
summary: Gets the filters for the certification schedule UI for Roles
description: Gets the filters for the certification schedule UI for Roles
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: array
items:
type: object
example: [{"id": "12345", "name": "Example Item", "description": "Sample record"}]
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/roleFiltersSuggest/suggest/activityDataSourceTypes:
get:
operationId: ui_SuggestResource_getActivityDataSourceTypesSuggest_9
tags:
- UI Suggest
summary: This endpoint returns List of ActivityDataSourceTypes
description: This endpoint returns List of ActivityDataSourceTypes
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/roleFiltersSuggest/suggest/applicationAttributes:
get:
operationId: ui_SuggestResource_getApplicationAttributes_9
tags:
- UI Suggest
summary: Returns data for ApplicationAttributes dropdown in Application Definition screen
description: Returns data for ApplicationAttributes dropdown in Application Definition screen
parameters:
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appName
required: false
description: The appName query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/roleFiltersSuggest/suggest/applications:
get:
operationId: ui_ApplicationSuggestResource_getApplications_9
tags:
- UI Suggest
summary: List of application maps for all applications
description: List of application maps for all applications
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/roleFiltersSuggest/suggest/applications/attributeValues:
post:
operationId: ui_ApplicationSuggestResource_getAttributeValues_9
tags:
- UI Suggest
summary: List of values for the given list of application and attribute
description: List of values for the given list of application and attribute
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"applications": "Example Application", "attributes": ["id", "name", "description"], "limit": 25, "query": "name sw \"example\"", "start": 0}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certificationSchedule/roleFiltersSuggest/suggest/column/{class}/{column}':
get:
operationId: ui_SuggestResource_getColumnSuggestViaHttpGet_9
tags:
- UI Suggest
summary: Returns a list of results for a suggest containing distinct column values on a given class type
description: Returns a list of results for a suggest containing distinct column values on a given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
- in: path
name: column
required: true
description: The column.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: ui_SuggestResource_getColumnSuggestViaHttpPost_9
tags:
- UI Suggest
summary: Returns a list of results for a suggest containing distinct column values on a given class type
description: Returns a list of results for a suggest containing distinct column values on a given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
- in: path
name: column
required: true
description: The column.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"displayName": "Example Name", "value": "example-value"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/roleFiltersSuggest/suggest/identityAttributes:
get:
operationId: ui_SuggestResource_getIdentityAttributes_9
tags:
- UI Suggest
summary: Returns data for IdentityAttributes dropdown in Application Definition Screen
description: Returns data for IdentityAttributes dropdown in Application Definition Screen
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certificationSchedule/roleFiltersSuggest/suggest/object/{class}':
get:
operationId: ui_SuggestResource_getSuggestViaHttpGet_9
tags:
- UI Suggest
summary: Returns a json data feed for a suggest component for the given class type
description: Returns a json data feed for a suggest component for the given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: ui_SuggestResource_getSuggestViaHttpPost_9
tags:
- UI Suggest
summary: Returns a json data feed for a suggest component for the given class type
description: Returns a json data feed for a suggest component for the given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"displayName": "Example Name", "value": "example-value"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/roleFiltersSuggest/suggest/operators:
get:
operationId: ui_SuggestResource_getOperators_9
tags:
- UI Suggest
summary: 'Returns Operators for dropdown in ConditionBasedCorrelation -> Correlation tab'
description: 'Returns Operators for dropdown in ConditionBasedCorrelation -> Correlation tab'
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/roleFiltersSuggest/suggest/provisioningActions:
get:
operationId: ui_SuggestResource_getProvisioningActionSuggest_9
tags:
- UI Suggest
summary: This endpoint returns list of provisioning actions in unstructured target page
description: This endpoint returns list of provisioning actions in unstructured target page
parameters:
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
- in: query
name: targetSourceType
required: false
description: The targetSourceType query parameter.
schema:
type: string
- in: query
name: provisioningOverridden
required: false
description: The provisioningOverridden query parameter.
schema:
type: boolean
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/roleFiltersSuggest/suggest/targetSourceTypes:
get:
operationId: ui_SuggestResource_getTargetSourceTypesSuggest_9
tags:
- UI Suggest
summary: This endpoint returns List of TargetSourceTypes corresponding to application type inside unstructured targets tab in the functionality of add/edit application
description: This endpoint returns List of TargetSourceTypes corresponding to application type inside unstructured targets tab in the functionality of add/edit application
parameters:
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/roleFiltersSuggest/suggest/targetSources:
get:
operationId: ui_SuggestResource_getTargetSourcesSuggest_9
tags:
- UI Suggest
summary: This endpoint returns List of TargetSources which are relevant for the application corresponding to application type inside unstructured targets tab in the functionality of add/edit application
description: This endpoint returns List of TargetSources which are relevant for the application corresponding to application type inside unstructured targets tab in the functionality of add/edit application
parameters:
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/suggest/suggest/activityDataSourceTypes:
get:
operationId: ui_SuggestResource_getActivityDataSourceTypesSuggest_10
tags:
- UI Suggest
summary: This endpoint returns List of ActivityDataSourceTypes
description: This endpoint returns List of ActivityDataSourceTypes
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/suggest/suggest/applicationAttributes:
get:
operationId: ui_SuggestResource_getApplicationAttributes_10
tags:
- UI Suggest
summary: Returns data for ApplicationAttributes dropdown in Application Definition screen
description: Returns data for ApplicationAttributes dropdown in Application Definition screen
parameters:
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appName
required: false
description: The appName query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/suggest/suggest/applications:
get:
operationId: ui_ApplicationSuggestResource_getApplications_10
tags:
- UI Suggest
summary: List of application maps for all applications
description: List of application maps for all applications
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/suggest/suggest/applications/attributeValues:
post:
operationId: ui_ApplicationSuggestResource_getAttributeValues_10
tags:
- UI Suggest
summary: List of values for the given list of application and attribute
description: List of values for the given list of application and attribute
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"applications": "Example Application", "attributes": ["id", "name", "description"], "limit": 25, "query": "name sw \"example\"", "start": 0}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certificationSchedule/suggest/suggest/column/{class}/{column}':
get:
operationId: ui_SuggestResource_getColumnSuggestViaHttpGet_10
tags:
- UI Suggest
summary: Returns a list of results for a suggest containing distinct column values on a given class type
description: Returns a list of results for a suggest containing distinct column values on a given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
- in: path
name: column
required: true
description: The column.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: ui_SuggestResource_getColumnSuggestViaHttpPost_10
tags:
- UI Suggest
summary: Returns a list of results for a suggest containing distinct column values on a given class type
description: Returns a list of results for a suggest containing distinct column values on a given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
- in: path
name: column
required: true
description: The column.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"displayName": "Example Name", "value": "example-value"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/suggest/suggest/identityAttributes:
get:
operationId: ui_SuggestResource_getIdentityAttributes_10
tags:
- UI Suggest
summary: Returns data for IdentityAttributes dropdown in Application Definition Screen
description: Returns data for IdentityAttributes dropdown in Application Definition Screen
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certificationSchedule/suggest/suggest/object/{class}':
get:
operationId: ui_SuggestResource_getSuggestViaHttpGet_10
tags:
- UI Suggest
summary: Returns a json data feed for a suggest component for the given class type
description: Returns a json data feed for a suggest component for the given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: ui_SuggestResource_getSuggestViaHttpPost_10
tags:
- UI Suggest
summary: Returns a json data feed for a suggest component for the given class type
description: Returns a json data feed for a suggest component for the given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"displayName": "Example Name", "value": "example-value"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/suggest/suggest/operators:
get:
operationId: ui_SuggestResource_getOperators_10
tags:
- UI Suggest
summary: 'Returns Operators for dropdown in ConditionBasedCorrelation -> Correlation tab'
description: 'Returns Operators for dropdown in ConditionBasedCorrelation -> Correlation tab'
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/suggest/suggest/provisioningActions:
get:
operationId: ui_SuggestResource_getProvisioningActionSuggest_10
tags:
- UI Suggest
summary: This endpoint returns list of provisioning actions in unstructured target page
description: This endpoint returns list of provisioning actions in unstructured target page
parameters:
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
- in: query
name: targetSourceType
required: false
description: The targetSourceType query parameter.
schema:
type: string
- in: query
name: provisioningOverridden
required: false
description: The provisioningOverridden query parameter.
schema:
type: boolean
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/suggest/suggest/targetSourceTypes:
get:
operationId: ui_SuggestResource_getTargetSourceTypesSuggest_10
tags:
- UI Suggest
summary: This endpoint returns List of TargetSourceTypes corresponding to application type inside unstructured targets tab in the functionality of add/edit application
description: This endpoint returns List of TargetSourceTypes corresponding to application type inside unstructured targets tab in the functionality of add/edit application
parameters:
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/suggest/suggest/targetSources:
get:
operationId: ui_SuggestResource_getTargetSourcesSuggest_10
tags:
- UI Suggest
summary: This endpoint returns List of TargetSources which are relevant for the application corresponding to application type inside unstructured targets tab in the functionality of add/edit application
description: This endpoint returns List of TargetSources which are relevant for the application corresponding to application type inside unstructured targets tab in the functionality of add/edit application
parameters:
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/targetPermissionFilters:
get:
operationId: ui_CertificationScheduleResource_getTargetPermissionFilters
tags:
- UI Certifications
summary: Gets the filters for the certification schedule UI for Target Permissions
description: Gets the filters for the certification schedule UI for Target Permissions
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: array
items:
type: object
example: [{"id": "12345", "name": "Example Item", "description": "Sample record"}]
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/targetPermissionFiltersSuggest/suggest/activityDataSourceTypes:
get:
operationId: ui_SuggestResource_getActivityDataSourceTypesSuggest_11
tags:
- UI Suggest
summary: This endpoint returns List of ActivityDataSourceTypes
description: This endpoint returns List of ActivityDataSourceTypes
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/targetPermissionFiltersSuggest/suggest/applicationAttributes:
get:
operationId: ui_SuggestResource_getApplicationAttributes_11
tags:
- UI Suggest
summary: Returns data for ApplicationAttributes dropdown in Application Definition screen
description: Returns data for ApplicationAttributes dropdown in Application Definition screen
parameters:
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appName
required: false
description: The appName query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/targetPermissionFiltersSuggest/suggest/applications:
get:
operationId: ui_ApplicationSuggestResource_getApplications_11
tags:
- UI Suggest
summary: List of application maps for all applications
description: List of application maps for all applications
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/targetPermissionFiltersSuggest/suggest/applications/attributeValues:
post:
operationId: ui_ApplicationSuggestResource_getAttributeValues_11
tags:
- UI Suggest
summary: List of values for the given list of application and attribute
description: List of values for the given list of application and attribute
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"applications": "Example Application", "attributes": ["id", "name", "description"], "limit": 25, "query": "name sw \"example\"", "start": 0}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certificationSchedule/targetPermissionFiltersSuggest/suggest/column/{class}/{column}':
get:
operationId: ui_SuggestResource_getColumnSuggestViaHttpGet_11
tags:
- UI Suggest
summary: Returns a list of results for a suggest containing distinct column values on a given class type
description: Returns a list of results for a suggest containing distinct column values on a given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
- in: path
name: column
required: true
description: The column.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: ui_SuggestResource_getColumnSuggestViaHttpPost_11
tags:
- UI Suggest
summary: Returns a list of results for a suggest containing distinct column values on a given class type
description: Returns a list of results for a suggest containing distinct column values on a given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
- in: path
name: column
required: true
description: The column.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"displayName": "Example Name", "value": "example-value"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/targetPermissionFiltersSuggest/suggest/identityAttributes:
get:
operationId: ui_SuggestResource_getIdentityAttributes_11
tags:
- UI Suggest
summary: Returns data for IdentityAttributes dropdown in Application Definition Screen
description: Returns data for IdentityAttributes dropdown in Application Definition Screen
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certificationSchedule/targetPermissionFiltersSuggest/suggest/object/{class}':
get:
operationId: ui_SuggestResource_getSuggestViaHttpGet_11
tags:
- UI Suggest
summary: Returns a json data feed for a suggest component for the given class type
description: Returns a json data feed for a suggest component for the given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: ui_SuggestResource_getSuggestViaHttpPost_11
tags:
- UI Suggest
summary: Returns a json data feed for a suggest component for the given class type
description: Returns a json data feed for a suggest component for the given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"displayName": "Example Name", "value": "example-value"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/targetPermissionFiltersSuggest/suggest/operators:
get:
operationId: ui_SuggestResource_getOperators_11
tags:
- UI Suggest
summary: 'Returns Operators for dropdown in ConditionBasedCorrelation -> Correlation tab'
description: 'Returns Operators for dropdown in ConditionBasedCorrelation -> Correlation tab'
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/targetPermissionFiltersSuggest/suggest/provisioningActions:
get:
operationId: ui_SuggestResource_getProvisioningActionSuggest_11
tags:
- UI Suggest
summary: This endpoint returns list of provisioning actions in unstructured target page
description: This endpoint returns list of provisioning actions in unstructured target page
parameters:
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
- in: query
name: targetSourceType
required: false
description: The targetSourceType query parameter.
schema:
type: string
- in: query
name: provisioningOverridden
required: false
description: The provisioningOverridden query parameter.
schema:
type: boolean
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/targetPermissionFiltersSuggest/suggest/targetSourceTypes:
get:
operationId: ui_SuggestResource_getTargetSourceTypesSuggest_11
tags:
- UI Suggest
summary: This endpoint returns List of TargetSourceTypes corresponding to application type inside unstructured targets tab in the functionality of add/edit application
description: This endpoint returns List of TargetSourceTypes corresponding to application type inside unstructured targets tab in the functionality of add/edit application
parameters:
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certificationSchedule/targetPermissionFiltersSuggest/suggest/targetSources:
get:
operationId: ui_SuggestResource_getTargetSourcesSuggest_11
tags:
- UI Suggest
summary: This endpoint returns List of TargetSources which are relevant for the application corresponding to application type inside unstructured targets tab in the functionality of add/edit application
description: This endpoint returns List of TargetSources which are relevant for the application corresponding to application type inside unstructured targets tab in the functionality of add/edit application
parameters:
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certifications:
get:
operationId: ui_CertificationListResource_getCertifications
tags:
- UI Certifications
summary: Get the list of certifications for the logged in user
description: Get the list of certifications for the logged in user
parameters:
- in: query
name: showSigned
required: false
description: The showSigned query parameter.
schema:
type: boolean
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/export/{certificationId}':
get:
operationId: ui_CertificationExportResource_exportCSV
tags:
- UI Certifications
summary: GET REST endpoint to trigger certification export
description: GET REST endpoint to trigger certification export
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certifications/preferences:
get:
operationId: ui_CertificationListResource_getAccessReviewPreferences
tags:
- UI Certifications
summary: Get access review list preferences for the logged in user
description: Get access review list preferences for the logged in user
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
put:
operationId: ui_CertificationListResource_setAccessReviewPreferences
tags:
- UI Certifications
summary: Update access review list preferences for the logged in user
description: Update access review list preferences for the logged in user
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"certifiers": "example-certifiers", "tags": "example-tags"}
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certifications/widgets/certificationCampaigns:
get:
operationId: ui_CertificationListResource_getCertificationCampaignsWidgetData
tags:
- UI Certifications
summary: Gets the data for the Certification Campaigns widget
description: Gets the data for the Certification Campaigns widget
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/certifications/widgets/myAccessReviews:
get:
operationId: ui_CertificationListResource_getMyAccessReviewsWidgetData
tags:
- UI Certifications
summary: Gets the data for the My Access Reviews widget
description: Gets the data for the My Access Reviews widget
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}':
get:
operationId: ui_CertificationResource_getCertification
tags:
- UI Certifications
summary: Get certification dto
description: Get certification dto
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
object:
type: object
description: The returned object
example: {"object": {"id": "abc-12345", "name": "Example Item"}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/config':
get:
operationId: ui_CertificationResource_getCertificationConfig
tags:
- UI Certifications
summary: 'Get a CertificationConfigDTO for the cert, with some UI configuration details'
description: 'Get a CertificationConfigDTO for the cert, with some UI configuration details'
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: CertificationConfigDTO
example: {"esigMeaning": "example-esigMeaning", "revocationModificationEnabled": true, "processRevokesImmediately": true, "defaultRevocationModificationOperation": "example-defaultRevocationModificationOperation", "useLinkAttributeValueForRevocationModification": true, "showRoleRevocationDetails": true, "bulkDecisions": ["example-value"], "bulkEntityDecisions": ["example-value"], "allowExceptionPopup": true, "allowExceptionDuration": {"calendarField": 0, "messageKey": "example-messageKey", "singleFormatString": "example-singleFormatString", "pluralFormatString": "example-pluralFormatString", "amount": 0, "scale": {}, "key": "example-key", "msg": {}, "cal": {}, "calendar": {}, "b": {}, "components": [{}], "sep": "example-sep", "ptr": "example-ptr", "scales": [{}], "d": {}}, "promptForSignoff": true, "showRecommendations": true, "autoApprove": true, "includeClassifications": true, "definition": {"name": "Example Item", "groupDefinition": {}, "certifiers": [{}], "checked": true, "id": "abc-12345", "certifierRuleName": "Example Certifierrule", "enabled": true, "startHowManyDays": 0, "onceEveryHowManyDays": 0, "before": true, "additionalEmailRecipientsPresent": true, "additionalRecipients": [{}], "emailTemplateId": "abc-12345", "recipientsRuleName": "Example Recipientsrule", "count": 1, "fromDb": true, "once": true, "maxReminders": 0, "escalationRuleId": "abc-12345", "displayField": "example-displayField", "icon": "example-icon", "startDate": "2024-01-01T00:00:00Z", "endDate": "2024-01-01T00:00:00Z", "sendReminders": true, "reminderEmailTemplate": "example-reminderEmailTemplate", "reminderFrequencyMillis": 0, "reminderStartMillisBeforeEnd": 0, "escalate": true, "escalationRule": "example-escalationRule", "escalationEmailTemplate": "example-escalationEmailTemplate", "escalationFrequencyMillis": 0, "escalationStartMillisBeforeEnd": 0, "applicationName": "Example Application", "schemaObjectType": "ExampleType", "attributes": {"key": "value"}, "tags": [{}], "freq": "example-freq", "sysConfig": {}, "entGranStr": "example-entGranStr", "duration": {}, "defaultSigName": "Example Defaultsig", "attrs": {"key": "value"}, "val": "example-val", "rule": {}, "result": {}, "newTags": [{}], "key": "example-key", "ownerIds": ["example-value"], "ops": {}, "names": ["example-value"], "certifierSelectionType": "ExampleType", "owner": "jsmith", "allowedLevel": "example-allowedLevel", "sysAllowedLevel": "example-sysAllowedLevel", "limitReassignments": true, "reassignmentLimit": 0, "assigneeName": "Example Assignee", "exceptionDuration": {}, "amount": 0, "scale": "example-scale", "require": true, "nameOrIds": ["example-value"], "groupBean": {}, "certifierIds": ["example-value"], "group": {}, "map": {"key": "value"}, "groupBeans": [{}], "groupDefIds": ["example-value"], "factoryBean": {}, "facmap": {"key": "value"}, "factory": {}, "factoryBeans": [{}], "factoryIds": ["example-value"], "bean": {}, "ruleName": "Example Rule", "f": {}, "o": "example-o", "filterValues": [{}], "list": {}, "configs": [{}], "certified": {}, "certReq": {}, "overdue": {}, "phases": [{}], "stagingPhase": {}, "activePeriodDuration": {}, "active": {}, "challengePeriodDuration": {}, "remediationPeriodDuration": {}, "template": "example-template", "valStr": "example-valStr", "notifConfig": {}, "notify": true, "emailTemplate": {}, "templateName": "Example Template", "attributeNames": ["example-value"], "methods": [{}], "editablePhase": {}, "setter": {}}, "configuration": {}, "availableBulkDecisions": ["example-value"], "decisions": ["example-value"], "qo": {"orderings": [{}], "groupBys": ["example-value"], "distinct": true, "ignoreCase": true, "firstRow": 0, "resultLimit": 0, "filters": [{}], "scopeExtensions": [{}], "scopeResults": true, "unscopedGloballyAccessible": true, "query": "example-query", "transactionLock": true, "cacheResults": true, "flushBeforeQuery": true, "cloneResults": true, "dirtyRead": true, "commitOnClone": true, "column": "example-column", "ascending": true, "ordering": {}, "o": {}, "f": {}, "id": "abc-12345", "children": [{}], "v": "example-v", "ownerFilter": {}, "ownerCol": "example-ownerCol", "workgroups": [{}], "owners": [{}], "qo": {}, "sb": {}}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/decisions':
post:
operationId: ui_CertificationResource_saveDecisions
tags:
- UI Certifications
summary: Save decisions on the certification
description: Save decisions on the certification
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"decisions": [{"itemId": "abc-12345", "action": "Approve", "comment": "Approved"}]}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
object:
type: object
description: The returned object
example: {"object": {"id": "abc-12345", "name": "Example Item"}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/email/reminder':
get:
operationId: ui_BaseEmailResource_getTemplate
tags:
- UI Certifications
summary: Fetches an EmailTemplateDTO that can be modified before sending
description: Fetches an EmailTemplateDTO that can be modified before sending
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: EmailTemplateDTO
example: {"to": "example-to", "from": "example-from", "subject": "example-subject", "body": "example-body", "comment": "example-comment", "cc": "example-cc", "bcc": "example-bcc", "toIdentity": {}, "sessionProperties": {"key": "value"}, "toIdentityReadOnly": true, "email": "user@example.com", "workgroup": true}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/email/reminder/send':
post:
operationId: ui_BaseEmailResource_sendEmail
tags:
- UI Certifications
summary: Sends the provided template out through the email service
description: Sends the provided template out through the email service
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"to": "example-to", "from": "example-from", "subject": "example-subject", "body": "example-body", "comment": "example-comment", "cc": "example-cc", "bcc": "example-bcc", "toIdentity": {}, "sessionProperties": {"key": "value"}, "toIdentityReadOnly": true, "email": "user@example.com", "workgroup": true}
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities':
get:
operationId: ui_CertificationEntityListResource_getCertificationEntities
tags:
- UI Certifications
summary: Get certification entities
description: Get certification entities
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: query
name: status
required: false
description: The status query parameter.
schema:
type: string
- in: query
name: excludedStatus
required: false
description: The excludedStatus query parameter.
schema:
type: string
- in: query
name: includeStatistics
required: false
description: The includeStatistics query parameter.
schema:
type: boolean
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/filters':
get:
operationId: ui_CertificationEntityListResource_getCertificationEntityFilters
tags:
- UI Certifications
summary: Get the filter for these certification entities
description: Get the filter for these certification entities
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: array
items:
type: object
example: [{"id": "12345", "name": "Example Item", "description": "Sample record"}]
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/ids':
get:
operationId: ui_CertificationEntityListResource_getCertificationEntityIds
tags:
- UI Certifications
summary: Get the IDs of all CertificationEntities that match the query parameters
description: Get the IDs of all CertificationEntities that match the query parameters
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: query
name: status
required: false
description: The status query parameter.
schema:
type: string
- in: query
name: excludedStatus
required: false
description: The excludedStatus query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: array
items:
type: object
example: [{"id": "12345", "name": "Example Item", "description": "Sample record"}]
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/suggest/entitlements/names':
get:
operationId: ui_CertificationItemSuggestResource_getNames
tags:
- UI Certifications
summary: 'Get suggest results for the entitlement names, combining attributes and permissions'
description: 'Get suggest results for the entitlement names, combining attributes and permissions'
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: query
name: application
required: false
description: The application query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/suggest/entitlements/values':
get:
operationId: ui_CertificationItemSuggestResource_getValues
tags:
- UI Certifications
summary: Get suggest results for the entitlement values for the given attribute/permission name
description: Get suggest results for the entitlement values for the given attribute/permission name
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: query
name: application
required: false
description: The application query parameter.
schema:
type: string
- in: query
name: name
required: false
description: The name query parameter.
schema:
type: string
- in: query
name: isPermission
required: false
description: The isPermission query parameter.
schema:
type: boolean
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/{entityId}':
get:
operationId: ui_CertificationEntityResource_getCertificationEntity
tags:
- UI Certifications
summary: Get CertificationEntityDTO
description: Get CertificationEntityDTO
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: CertificationEntityDTO
example: {"targetId": "abc-12345", "itemStatusCount": {"counts": {"key": "value"}, "arr": [{}], "map": {"key": "value"}}, "identityAttributes": {"attributeName": "Example Attribute", "label": "example-label", "value": "example-value", "authorizedToView": true, "attributes": [{}]}, "scorecard": {"scoreItem": {}, "typeName": "Example Type", "targetMsg": {}, "index": {}, "scores": [{}], "scoreItems": [{}], "i": [{}], "used": {}, "parent": "example-parent", "raw": {}, "categoryDisplayName": "Example Categorydisplay", "category": "example-category", "scoreColorMap": {"key": "value"}, "compensatedScoreColorMap": {"key": "value"}, "params": [{}], "displayableNames": ["example-value"], "msg": "example-msg"}, "differences": {"attributeDifferences": [{}], "linkDifferences": [{}], "permissionDifferences": [{}], "diffs": [{}], "newDiff": {}, "itDiff": {}, "nextDiff": {}, "newContext": "Example message text"}, "description": "A brief description.", "displayableName": "Example Displayable", "attribute": "example-attribute", "delegation": {}, "certificationItemCount": 1, "permission": "example-permission", "nativeIdentity": "example-nativeIdentity", "accountGroup": "example-accountGroup", "email": "user@example.com", "identityName": "Example Identity", "hasAutoApprovals": true}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/{entityId}/items':
get:
operationId: ui_CertificationItemListResource_getCertificationItems
tags:
- UI Certifications
summary: Get a ListResult representing certification items of specific summary status
description: Get a ListResult representing certification items of specific summary status
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId path parameter.
schema:
type: string
- in: query
name: colKey
required: false
description: The colKey query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/{entityId}/items/filters':
get:
operationId: ui_CertificationItemListResource_getCertificationItemFilters
tags:
- UI Certifications
summary: Get the filter for these certification items
description: Get the filter for these certification items
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: array
items:
type: object
example: [{"id": "12345", "name": "Example Item", "description": "Sample record"}]
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/{entityId}/items/suggest/entitlements/names':
get:
operationId: ui_CertificationItemSuggestResource_getNames_2
tags:
- UI Certifications
summary: 'Get suggest results for the entitlement names, combining attributes and permissions'
description: 'Get suggest results for the entitlement names, combining attributes and permissions'
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId path parameter.
schema:
type: string
- in: query
name: application
required: false
description: The application query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/{entityId}/items/suggest/entitlements/values':
get:
operationId: ui_CertificationItemSuggestResource_getValues_2
tags:
- UI Certifications
summary: Get suggest results for the entitlement values for the given attribute/permission name
description: Get suggest results for the entitlement values for the given attribute/permission name
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId path parameter.
schema:
type: string
- in: query
name: application
required: false
description: The application query parameter.
schema:
type: string
- in: query
name: name
required: false
description: The name query parameter.
schema:
type: string
- in: query
name: isPermission
required: false
description: The isPermission query parameter.
schema:
type: boolean
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/{entityId}/items/{itemId}/accountDetails':
get:
operationId: ui_ApplicationAccountDetailResource_getApplicationAccountDetails
tags:
- UI Certifications
summary: Get a ApplicationDTO to represent the application
description: Get a ApplicationDTO to represent the application
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: ApplicationAccountDTO
example: {"application": {"id": "abc-12345", "name": "Example Item", "description": "A brief description.", "type": "ExampleType", "owner": {}, "remediators": [{}]}, "accountName": "Example Account", "nativeIdentity": "example-nativeIdentity", "linkAttributes": [{"name": "Example Item", "displayName": "Example Display", "values": [{}], "permission": true, "entitlement": true, "description": "A brief description."}], "entitlements": [{"nativeIdentity": "example-nativeIdentity", "accountName": "Example Account", "assigned": true, "grantedByRole": true, "startDate": "2024-01-01T00:00:00Z", "endDate": "2024-01-01T00:00:00Z", "lastCertDate": "2024-01-01T00:00:00Z", "lastCertName": "Example Lastcert", "lastCertificationItem": {}, "pendingCertificationItem": {}, "lastRequestItem": {}, "pendingRequestItem": {}, "assigner": "example-assigner", "source": "example-source", "foundOnAccount": true, "detectedRole": true, "hasPendingRequest": true, "pendingRequestId": "abc-12345", "allowed": true, "entitlementRequireEndDateTime": true, "entitlementMaxAccessTimeEnabled": true, "entitlementMaxAccessTimeValue": 0, "entitlementMaxAccessTimeUnit": "example-entitlementMaxAccessTimeUnit", "sourceAssignableRoleNames": ["example-value"], "sourceDetectableRoleNames": ["example-value"], "lastItem": {}, "pendingItem": {}}], "targetPermissions": [{"nativeIdentity": "example-nativeIdentity", "accountName": "Example Account", "assigned": true, "grantedByRole": true, "startDate": "2024-01-01T00:00:00Z", "endDate": "2024-01-01T00:00:00Z", "lastCertDate": "2024-01-01T00:00:00Z", "lastCertName": "Example Lastcert", "lastCertificationItem": {}, "pendingCertificationItem": {}, "lastRequestItem": {}, "pendingRequestItem": {}, "assigner": "example-assigner", "source": "example-source", "foundOnAccount": true, "detectedRole": true, "hasPendingRequest": true, "pendingRequestId": "abc-12345", "allowed": true, "entitlementRequireEndDateTime": true, "entitlementMaxAccessTimeEnabled": true, "entitlementMaxAccessTimeValue": 0, "entitlementMaxAccessTimeUnit": "example-entitlementMaxAccessTimeUnit", "sourceAssignableRoleNames": ["example-value"], "sourceDetectableRoleNames": ["example-value"], "lastItem": {}, "pendingItem": {}}], "iiqElevatedAccess": true}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/{entityId}/items/{itemId}/comment':
post:
operationId: ui_CertificationItemResource_postEntitlementComment
tags:
- UI Certifications
summary: 'Add an entitlement comment to the identity''s history'
description: 'Add an entitlement comment to the identity''s history'
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"entityDecision": "example-entityDecision", "itemType": "Identity", "recipient": "example-recipient", "remediationDetails": "example-remediationDetails", "selectionCriteria": "name sw \"example\"", "status": "Active"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/{entityId}/items/{itemId}/delegationDescription':
get:
operationId: ui_CertificationItemResource_getDelegationDescription
tags:
- UI Certifications
summary: Get the delegation description for this certification item
description: Get the delegation description for this certification item
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: DecisionSummary
example: {"id": "abc-12345", "itemType": {}, "owner": {"id": "abc-12345", "name": "Example Item", "displayName": "Example Display"}, "defaultRemediator": {"id": "abc-12345", "name": "Example Item", "displayName": "Example Display"}, "enableOverrideDefaultRemediator": true, "description": "A brief description.", "comments": "example-comments", "violationConstraint": "example-violationConstraint", "violationSummary": "example-violationSummary", "remediationAdvice": "example-remediationAdvice", "assignmentOptions": [{}], "mitigationExpiration": 0, "provisioners": ["example-value"], "remediationDetails": [{"id": 0, "account": 1, "nativeIdentity": "example-nativeIdentity", "application": "Example Application", "applicationId": "abc-12345", "attribute": "example-attribute", "attributeValue": "example-attributeValue", "permissionTarget": "example-permissionTarget", "permissionRights": ["example-value"], "editable": true, "canChangeValue": true, "inputType": "ExampleType", "selectOptions": [{}], "operation": ["example-value"], "existingRemediation": true, "attributeDisplayValue": "example-attributeDisplayValue", "newValue": "example-newValue", "newOperation": "example-newOperation", "qo": {}, "appResult": ["example-value"], "defaultRemediationModifiableOp": "example-defaultRemediationModifiableOp"}], "useManagedAttributesForRemediation": true, "delegation": {}, "entityDelegation": {}, "additionalRoles": ["example-value"], "requiredOrPermittedRoles": ["example-value"], "completionComments": "example-completionComments", "violationDetailer": {"violation": {}, "policy": {}, "policyName": "Example Policy", "policyType": "ExampleType", "id": "abc-12345", "compensatingControl": "example-compensatingControl", "constraintDescription": "A brief description.", "constraintWeight": "example-constraintWeight", "constraint": "example-constraint", "constraintPolicy": "example-constraintPolicy", "remediationAdvice": "example-remediationAdvice", "summary": "example-summary", "sodConflict": "example-sodConflict", "status": "Active", "renderer": "example-renderer", "createdDate": "2024-01-01T00:00:00Z", "args": {"key": "value"}, "activity": {}, "identityName": "Example Identity", "identityFirstname": "Example Identityfirst", "identityLastname": "Example Identitylast", "identityId": "abc-12345", "ownerName": "Example Owner", "lastDecision": {}, "lastDecisionFound": true, "base": {}, "identity": {}, "localizer": {}, "left": "example-left", "right": "example-right", "msg": {}, "builder": {}, "decision": {}}, "delegationOwner": {"objectConfig": {}, "systemAttributes": {"key": "value"}, "links": [{}], "detectedRoles": [{}], "assignedRoles": [{}], "roleMetadatas": [{}], "exceptions": [{}], "mitigationExpirations": [{}], "preferences": {"key": "value"}, "manager": {}, "capabilities": [{}], "controlledScopes": [{}], "controlsAssignedScope": true, "password": "**hidden**", "scorecard": {}, "lastLogin": "example-lastLogin", "lastRefresh": "example-lastRefresh", "activityConfig": {}, "capabilityManager": {}, "authApplication": {}, "authAccount": {}, "identityEntitlements": [{}], "correlatedOverridden": true, "flattenedRights": {}, "effectiveRights": {}, "bundleSummary": "example-bundleSummary", "assignedRoleSummary": "example-assignedRoleSummary", "attributes": {"key": "value"}, "uiPreferences": {}, "passwordExpiration": "example-passwordExpiration", "passwordHistory": "example-passwordHistory", "authenticationAnswers": [{}], "authLockStart": "example-authLockStart", "certifications": [{}], "workgroups": [{}], "administrator": {}, "extendedIdentity1": {}, "extendedIdentity2": {}, "extendedIdentity3": {}, "extendedIdentity4": {}, "extendedIdentity5": {}, "config": {}, "value": "example-value", "name": "Example Item", "key": "example-key", "buildList": [{}], "def": {}, "sources": [{}], "metadata": {}, "displayName": "Example Display", "custom": {"key": "value"}, "keys": ["example-value"], "atts": {"key": "value"}, "attributeDefinition": {}, "result": {}, "attr": "example-attr", "found": [{}], "linkInstance": "example-linkInstance", "displayNameFound": {}, "uuidFound": {}, "uuid": "abc-12345", "id": "abc-12345", "appname": "Example App", "identity": "example-identity", "composite": {}, "composites": [{}], "collection": {}, "attrs": {"key": "value"}, "es": {}, "assignedAndDetectedRoles": [{}], "inheritance": [{}], "requirements": [{}], "summary": "example-summary", "buf": {}, "bundles": [{}], "existingMetadata": {}, "appId": "abc-12345", "it": {}, "l": {}, "link": {}, "d": "example-d", "last": "example-last", "certLinks": {}, "svc": {}, "historyItem": {}, "snapshots": {"key": "value"}, "caps": [{}], "directRights": ["example-value"], "indirectRights": ["example-value"], "effective": [{}], "localCaps": [{}], "indirect": [{}], "capNames": ["example-value"], "scopes": [{}], "groups": [{}], "wgScopes": [{}], "scopeIt": {}, "distinctScopes": [{}], "scope": {}, "childScopes": [{}], "scopeNames": ["example-value"], "val": "example-val", "current": [{}], "ass": {}, "assignments": [{}], "o": "example-o", "assign": {}, "as": {}, "roles": [{}], "list": [{}], "negativeAssignments": [{}], "active": [{}], "foundAssignments": [{}], "match": {}, "assignment": {}, "requests": [{}], "appRoleDetects": [{}], "filteredDetections": [{}], "detections": [{}], "det": {}, "otherId": "abc-12345", "unassignedDetection": {}, "mappings": {"key": "value"}, "role": {}, "ents": [{}], "comparator": {}, "appCerts": {"key": "value"}, "conflictingCert": {}, "certLinkArray": [{}], "triggers": {"key": "value"}, "standardAttributeNames": ["example-value"], "type": {}}, "map": {"key": "value"}, "identity": {"id": "abc-12345", "name": "Example Item", "displayName": "Example Display"}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/{entityId}/items/{itemId}/history':
get:
operationId: ui_CertificationItemResource_getIdentityHistory
tags:
- UI Certifications
summary: Get the identity history result data from the identity history list service and add in the temp decision if there is no history data found
description: Get the identity history result data from the identity history list service and add in the temp decision if there is no history data found
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/{entityId}/items/{itemId}/identityAttributes':
get:
operationId: ui_CertificationItemResource_getIdentityAttributes
tags:
- UI Certifications
summary: Returns IdentityAttributesDTO for certification item
description: Returns IdentityAttributesDTO for certification item
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: IdentityAttributesDTO
example: {"attributeName": "Example Attribute", "label": "example-label", "value": "example-value", "authorizedToView": true, "attributes": [{}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/{entityId}/items/{itemId}/linkAttributes':
get:
operationId: ui_CertificationItemResource_getLinkAttributes
tags:
- UI Certifications
summary: Returns LinkAttributesDTOs for the identity on the certification item uses start and limit query parameters
description: Returns LinkAttributesDTOs for the identity on the certification item uses start and limit query parameters
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/{entityId}/items/{itemId}/managedAttributeDetails':
get:
operationId: ui_ManagedAttributeDetailResource_getDetails_3
tags:
- Managed Attributes
summary: Get the details for the managed attribute
description: Get the details for the managed attribute
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: ManagedAttributeDetailDTO
example: {"id": "abc-12345", "application": "Example Application", "type": "ExampleType", "attribute": "example-attribute", "value": "example-value", "displayValue": "example-displayValue", "description": "A brief description.", "owner": "jsmith", "requestable": true, "iiqElevatedAccess": true, "extendedAttributes": {"key": "value"}, "groupAttributes": {"key": "value"}, "groupEntitlements": [{"nativeIdentity": "example-nativeIdentity", "accountName": "Example Account", "assigned": true, "grantedByRole": true, "startDate": "2024-01-01T00:00:00Z", "endDate": "2024-01-01T00:00:00Z", "lastCertDate": "2024-01-01T00:00:00Z", "lastCertName": "Example Lastcert", "lastCertificationItem": {}, "pendingCertificationItem": {}, "lastRequestItem": {}, "pendingRequestItem": {}, "assigner": "example-assigner", "source": "example-source", "foundOnAccount": true, "detectedRole": true, "hasPendingRequest": true, "pendingRequestId": "abc-12345", "allowed": true, "entitlementRequireEndDateTime": true, "entitlementMaxAccessTimeEnabled": true, "entitlementMaxAccessTimeValue": 0, "entitlementMaxAccessTimeUnit": "example-entitlementMaxAccessTimeUnit", "sourceAssignableRoleNames": ["example-value"], "sourceDetectableRoleNames": ["example-value"], "lastItem": {}, "pendingItem": {}}], "hasInheritance": true, "hasAccess": true, "hasMembers": true, "hasClassifications": true, "hasCloudAccess": true, "hasRoles": true}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/{entityId}/items/{itemId}/managedAttributeDetails/cam/group':
get:
operationId: ui_ManagedAttributeDetailResource_getGroup_3
tags:
- Managed Attributes
summary: Gets the sub resource for getting the CAM group details for this managed attribute
description: Gets the sub resource for getting the CAM group details for this managed attribute
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: CAMGroupDTO
example: {"errors": ["example-value"], "roles": [{"nativeId": "abc-12345", "cspType": "ExampleType", "displayName": "Example Display", "uri": "https://example.sailpoint.com", "adminCount": 1, "writeCount": 1, "readCount": 1, "scopes": [{}], "errors": ["example-value"], "camScopeDTO": {}}], "services": [{"name": "Example Item", "type": "ExampleType", "numResources": 0}], "uri": "https://example.sailpoint.com", "cspType": "ExampleType", "nativeId": "abc-12345", "displayName": "Example Display", "rolesList": {"items": [{}], "federatedRolesList": {}, "sb": {}}, "servicesList": {"items": [{}], "servicesList": {}, "sb": {}}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/{entityId}/items/{itemId}/managedAttributeDetails/cam/scope':
get:
operationId: ui_ManagedAttributeDetailResource_getScopeServices_3
tags:
- Managed Attributes
summary: Gets the sub resource for getting the CAM details for this managed attribute
description: Gets the sub resource for getting the CAM details for this managed attribute
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: query
name: uri
required: false
description: The uri query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/{entityId}/items/{itemId}/remediationAdvice':
get:
operationId: ui_CertificationItemResource_getViolationRemediationAdvice
tags:
- UI Certifications
summary: Get the remediation advice for this certification item
description: Get the remediation advice for this certification item
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: RemediationAdviceResult
example: {"advice": {"violationConstraint": "example-violationConstraint", "violationSummary": "example-violationSummary", "remediationAdvice": "example-remediationAdvice", "rightRoles": [{}], "leftRoles": [{}], "entitlementsToRemediate": {}, "map": {"key": "value"}, "name": "Example Item", "result": {"key": "value"}, "description": "A brief description."}, "summary": {"id": "abc-12345", "itemType": {}, "owner": {}, "defaultRemediator": {}, "enableOverrideDefaultRemediator": true, "description": "A brief description.", "comments": "example-comments", "violationConstraint": "example-violationConstraint", "violationSummary": "example-violationSummary", "remediationAdvice": "example-remediationAdvice", "assignmentOptions": [{}], "mitigationExpiration": 0, "provisioners": ["example-value"], "remediationDetails": [{}], "useManagedAttributesForRemediation": true, "delegation": {}, "entityDelegation": {}, "additionalRoles": ["example-value"], "requiredOrPermittedRoles": ["example-value"], "completionComments": "example-completionComments", "violationDetailer": {}, "delegationOwner": {}, "map": {"key": "value"}, "identity": {}}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/{entityId}/items/{itemId}/remediationSummary':
post:
operationId: ui_CertificationItemResource_getRemediationSummary
tags:
- UI Certifications
summary: Gets the remediation summary for this certification item
description: Gets the remediation summary for this certification item
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"entityDecision": "example-entityDecision", "itemType": "Identity", "recipient": "example-recipient", "remediationDetails": "example-remediationDetails", "selectionCriteria": "name sw \"example\"", "status": "Active"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: DecisionSummary
example: {"id": "abc-12345", "itemType": {}, "owner": {"id": "abc-12345", "name": "Example Item", "displayName": "Example Display"}, "defaultRemediator": {"id": "abc-12345", "name": "Example Item", "displayName": "Example Display"}, "enableOverrideDefaultRemediator": true, "description": "A brief description.", "comments": "example-comments", "violationConstraint": "example-violationConstraint", "violationSummary": "example-violationSummary", "remediationAdvice": "example-remediationAdvice", "assignmentOptions": [{}], "mitigationExpiration": 0, "provisioners": ["example-value"], "remediationDetails": [{"id": 0, "account": 1, "nativeIdentity": "example-nativeIdentity", "application": "Example Application", "applicationId": "abc-12345", "attribute": "example-attribute", "attributeValue": "example-attributeValue", "permissionTarget": "example-permissionTarget", "permissionRights": ["example-value"], "editable": true, "canChangeValue": true, "inputType": "ExampleType", "selectOptions": [{}], "operation": ["example-value"], "existingRemediation": true, "attributeDisplayValue": "example-attributeDisplayValue", "newValue": "example-newValue", "newOperation": "example-newOperation", "qo": {}, "appResult": ["example-value"], "defaultRemediationModifiableOp": "example-defaultRemediationModifiableOp"}], "useManagedAttributesForRemediation": true, "delegation": {}, "entityDelegation": {}, "additionalRoles": ["example-value"], "requiredOrPermittedRoles": ["example-value"], "completionComments": "example-completionComments", "violationDetailer": {"violation": {}, "policy": {}, "policyName": "Example Policy", "policyType": "ExampleType", "id": "abc-12345", "compensatingControl": "example-compensatingControl", "constraintDescription": "A brief description.", "constraintWeight": "example-constraintWeight", "constraint": "example-constraint", "constraintPolicy": "example-constraintPolicy", "remediationAdvice": "example-remediationAdvice", "summary": "example-summary", "sodConflict": "example-sodConflict", "status": "Active", "renderer": "example-renderer", "createdDate": "2024-01-01T00:00:00Z", "args": {"key": "value"}, "activity": {}, "identityName": "Example Identity", "identityFirstname": "Example Identityfirst", "identityLastname": "Example Identitylast", "identityId": "abc-12345", "ownerName": "Example Owner", "lastDecision": {}, "lastDecisionFound": true, "base": {}, "identity": {}, "localizer": {}, "left": "example-left", "right": "example-right", "msg": {}, "builder": {}, "decision": {}}, "delegationOwner": {"objectConfig": {}, "systemAttributes": {"key": "value"}, "links": [{}], "detectedRoles": [{}], "assignedRoles": [{}], "roleMetadatas": [{}], "exceptions": [{}], "mitigationExpirations": [{}], "preferences": {"key": "value"}, "manager": {}, "capabilities": [{}], "controlledScopes": [{}], "controlsAssignedScope": true, "password": "**hidden**", "scorecard": {}, "lastLogin": "example-lastLogin", "lastRefresh": "example-lastRefresh", "activityConfig": {}, "capabilityManager": {}, "authApplication": {}, "authAccount": {}, "identityEntitlements": [{}], "correlatedOverridden": true, "flattenedRights": {}, "effectiveRights": {}, "bundleSummary": "example-bundleSummary", "assignedRoleSummary": "example-assignedRoleSummary", "attributes": {"key": "value"}, "uiPreferences": {}, "passwordExpiration": "example-passwordExpiration", "passwordHistory": "example-passwordHistory", "authenticationAnswers": [{}], "authLockStart": "example-authLockStart", "certifications": [{}], "workgroups": [{}], "administrator": {}, "extendedIdentity1": {}, "extendedIdentity2": {}, "extendedIdentity3": {}, "extendedIdentity4": {}, "extendedIdentity5": {}, "config": {}, "value": "example-value", "name": "Example Item", "key": "example-key", "buildList": [{}], "def": {}, "sources": [{}], "metadata": {}, "displayName": "Example Display", "custom": {"key": "value"}, "keys": ["example-value"], "atts": {"key": "value"}, "attributeDefinition": {}, "result": {}, "attr": "example-attr", "found": [{}], "linkInstance": "example-linkInstance", "displayNameFound": {}, "uuidFound": {}, "uuid": "abc-12345", "id": "abc-12345", "appname": "Example App", "identity": "example-identity", "composite": {}, "composites": [{}], "collection": {}, "attrs": {"key": "value"}, "es": {}, "assignedAndDetectedRoles": [{}], "inheritance": [{}], "requirements": [{}], "summary": "example-summary", "buf": {}, "bundles": [{}], "existingMetadata": {}, "appId": "abc-12345", "it": {}, "l": {}, "link": {}, "d": "example-d", "last": "example-last", "certLinks": {}, "svc": {}, "historyItem": {}, "snapshots": {"key": "value"}, "caps": [{}], "directRights": ["example-value"], "indirectRights": ["example-value"], "effective": [{}], "localCaps": [{}], "indirect": [{}], "capNames": ["example-value"], "scopes": [{}], "groups": [{}], "wgScopes": [{}], "scopeIt": {}, "distinctScopes": [{}], "scope": {}, "childScopes": [{}], "scopeNames": ["example-value"], "val": "example-val", "current": [{}], "ass": {}, "assignments": [{}], "o": "example-o", "assign": {}, "as": {}, "roles": [{}], "list": [{}], "negativeAssignments": [{}], "active": [{}], "foundAssignments": [{}], "match": {}, "assignment": {}, "requests": [{}], "appRoleDetects": [{}], "filteredDetections": [{}], "detections": [{}], "det": {}, "otherId": "abc-12345", "unassignedDetection": {}, "mappings": {"key": "value"}, "role": {}, "ents": [{}], "comparator": {}, "appCerts": {"key": "value"}, "conflictingCert": {}, "certLinkArray": [{}], "triggers": {"key": "value"}, "standardAttributeNames": ["example-value"], "type": {}}, "map": {"key": "value"}, "identity": {"id": "abc-12345", "name": "Example Item", "displayName": "Example Display"}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/{entityId}/items/{itemId}/roleDetails':
get:
operationId: ui_RoleDetailResource_getDetails_2
tags:
- Roles
summary: Get a RoleDetailDTO to represent to current role
description: Get a RoleDetailDTO to represent to current role
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: RoleDetailDTO
example: {"id": "abc-12345", "identityId": "abc-12345", "identityDisplayName": "Example Identitydisplay", "assignmentId": "abc-12345", "identityHasRole": true, "assigned": true, "detected": true, "displayName": "Example Display", "type": "ExampleType", "typeIcon": "example-typeIcon", "owner": {"id": "abc-12345", "name": "Example Item", "displayName": "Example Display"}, "description": "A brief description.", "iiqElevatedAccess": true, "permittedBy": "example-permittedBy", "assignmentNote": "example-assignmentNote", "accountDetails": [{"value": "example-value", "application": "Example Application", "account": 1, "nativeIdentity": "example-nativeIdentity", "sourceRole": "example-sourceRole", "iiqElevatedAccess": true}], "contributingEntitlements": [{"nativeIdentity": "example-nativeIdentity", "accountName": "Example Account", "assigned": true, "grantedByRole": true, "startDate": "2024-01-01T00:00:00Z", "endDate": "2024-01-01T00:00:00Z", "lastCertDate": "2024-01-01T00:00:00Z", "lastCertName": "Example Lastcert", "lastCertificationItem": {}, "pendingCertificationItem": {}, "lastRequestItem": {}, "pendingRequestItem": {}, "assigner": "example-assigner", "source": "example-source", "foundOnAccount": true, "detectedRole": true, "hasPendingRequest": true, "pendingRequestId": "abc-12345", "allowed": true, "entitlementRequireEndDateTime": true, "entitlementMaxAccessTimeEnabled": true, "entitlementMaxAccessTimeValue": 0, "entitlementMaxAccessTimeUnit": "example-entitlementMaxAccessTimeUnit", "sourceAssignableRoleNames": ["example-value"], "sourceDetectableRoleNames": ["example-value"], "lastItem": {}, "pendingItem": {}}], "permittedRoles": [{}], "requiredRoles": [{}], "hierarchy": [{}], "hasHierarchy": true, "classificationNames": ["example-value"], "profiles": [{"name": "Example Item", "application": "Example Application", "iiqElevatedAccess": true, "constraints": ["example-value"], "permissions": [{}], "entitlements": [{}]}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/{entityId}/items/{itemId}/roleDetails/simpleEntitlements':
get:
operationId: ui_RoleDetailResource_getSimpleEntitlements_2
tags:
- Roles
summary: Returns a list of simple entitlements on the specified role
description: Returns a list of simple entitlements on the specified role
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/{entityId}/items/{itemId}/roleDetails/{subRoleId}/hierarchy':
get:
operationId: ui_RoleDetailResource_getHierarchy_2
tags:
- Roles
summary: Get a list of RoleDetailDTOs to represent the next level of hierarchy for the given sub role
description: Get a list of RoleDetailDTOs to represent the next level of hierarchy for the given sub role
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: subRoleId
required: true
description: The subRoleId.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: array
items:
type: object
example: [{"id": "12345", "name": "Example Item", "description": "Sample record"}]
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/{entityId}/items/{itemId}/roleProfile':
get:
operationId: ui_CertificationItemProfileResource_getRoleProfileDTO
tags:
- UI Certifications
summary: Returns the RoleProfile details for the given CertificationItem
description: Returns the RoleProfile details for the given CertificationItem
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: RoleProfileDTO
example: {"name": "Example Item", "application": "Example Application", "iiqElevatedAccess": true, "constraints": ["example-value"], "permissions": [{"target": "example-target", "rights": "example-rights", "iiqElevatedAccess": true}], "entitlements": [{"application": "Example Application", "applicationId": "abc-12345", "attribute": "example-attribute", "name": "Example Item", "value": "example-value", "displayValue": "example-displayValue", "description": "A brief description.", "group": true, "permission": true, "annotation": "example-annotation", "localizedType": "ExampleType", "iiqEntitlement": true, "managedAttributeId": "abc-12345", "classificationNames": ["example-value"], "iiqElevatedAccess": true, "app": {}, "managedAttribute": {}}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/{entityId}/managedAttributeDetails':
get:
operationId: ui_ManagedAttributeDetailResource_getDetails_4
tags:
- Managed Attributes
summary: Get the details for the managed attribute
description: Get the details for the managed attribute
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: ManagedAttributeDetailDTO
example: {"id": "abc-12345", "application": "Example Application", "type": "ExampleType", "attribute": "example-attribute", "value": "example-value", "displayValue": "example-displayValue", "description": "A brief description.", "owner": "jsmith", "requestable": true, "iiqElevatedAccess": true, "extendedAttributes": {"key": "value"}, "groupAttributes": {"key": "value"}, "groupEntitlements": [{"nativeIdentity": "example-nativeIdentity", "accountName": "Example Account", "assigned": true, "grantedByRole": true, "startDate": "2024-01-01T00:00:00Z", "endDate": "2024-01-01T00:00:00Z", "lastCertDate": "2024-01-01T00:00:00Z", "lastCertName": "Example Lastcert", "lastCertificationItem": {}, "pendingCertificationItem": {}, "lastRequestItem": {}, "pendingRequestItem": {}, "assigner": "example-assigner", "source": "example-source", "foundOnAccount": true, "detectedRole": true, "hasPendingRequest": true, "pendingRequestId": "abc-12345", "allowed": true, "entitlementRequireEndDateTime": true, "entitlementMaxAccessTimeEnabled": true, "entitlementMaxAccessTimeValue": 0, "entitlementMaxAccessTimeUnit": "example-entitlementMaxAccessTimeUnit", "sourceAssignableRoleNames": ["example-value"], "sourceDetectableRoleNames": ["example-value"], "lastItem": {}, "pendingItem": {}}], "hasInheritance": true, "hasAccess": true, "hasMembers": true, "hasClassifications": true, "hasCloudAccess": true, "hasRoles": true}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/{entityId}/managedAttributeDetails/access':
get:
operationId: ui_TargetAssociationListResource_getAssociations_3
tags:
- Managed Attributes
summary: Get associations
description: Get associations
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/{entityId}/managedAttributeDetails/cam/group':
get:
operationId: ui_ManagedAttributeDetailResource_getGroup_4
tags:
- Managed Attributes
summary: Gets the sub resource for getting the CAM group details for this managed attribute
description: Gets the sub resource for getting the CAM group details for this managed attribute
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: CAMGroupDTO
example: {"errors": ["example-value"], "roles": [{"nativeId": "abc-12345", "cspType": "ExampleType", "displayName": "Example Display", "uri": "https://example.sailpoint.com", "adminCount": 1, "writeCount": 1, "readCount": 1, "scopes": [{}], "errors": ["example-value"], "camScopeDTO": {}}], "services": [{"name": "Example Item", "type": "ExampleType", "numResources": 0}], "uri": "https://example.sailpoint.com", "cspType": "ExampleType", "nativeId": "abc-12345", "displayName": "Example Display", "rolesList": {"items": [{}], "federatedRolesList": {}, "sb": {}}, "servicesList": {"items": [{}], "servicesList": {}, "sb": {}}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/{entityId}/managedAttributeDetails/cam/scope':
get:
operationId: ui_ManagedAttributeDetailResource_getScopeServices_4
tags:
- Managed Attributes
summary: Gets the sub resource for getting the CAM details for this managed attribute
description: Gets the sub resource for getting the CAM details for this managed attribute
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId path parameter.
schema:
type: string
- in: query
name: uri
required: false
description: The uri query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/{entityId}/managedAttributeDetails/cam/service':
get:
operationId: ui_CAMResourcesListResource_getServiceResources_3
tags:
- UI CAM
summary: Get the list of CAM resources
description: Get the list of CAM resources
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/{entityId}/managedAttributeDetails/classifications':
get:
operationId: ui_ClassificationListResource_getClassifications_4
tags:
- Managed Attributes
summary: Public GET method to retrieve a ListResult of ClassificationDTOs
description: Public GET method to retrieve a ListResult of ClassificationDTOs
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/{entityId}/managedAttributeDetails/inheritance/children':
get:
operationId: ui_ManagedAttributeInheritanceListResource_getChildren_3
tags:
- Managed Attributes
summary: Gets the children managed attributes based on inheritance
description: Gets the children managed attributes based on inheritance
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/{entityId}/managedAttributeDetails/inheritance/parents':
get:
operationId: ui_ManagedAttributeInheritanceListResource_getParents_3
tags:
- Managed Attributes
summary: Gets the parent managed attributes based on inheritance
description: Gets the parent managed attributes based on inheritance
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/{entityId}/managedAttributeDetails/members':
get:
operationId: ui_AccountGroupMemberListResource_getMembers_3
tags:
- UI Me
summary: Get the list of account group members
description: Get the list of account group members
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/{entityId}/managedAttributeDetails/roles':
get:
operationId: ui_AccountGroupRolesListResource_getRoles_3
tags:
- UI Approvals
summary: Get the list of associated roles for ManagedAttribute
description: Get the list of associated roles for ManagedAttribute
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/{entityId}/roleDetails':
get:
operationId: ui_RoleDetailResource_getDetails_3
tags:
- Roles
summary: Get a RoleDetailDTO to represent to current role
description: Get a RoleDetailDTO to represent to current role
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: RoleDetailDTO
example: {"id": "abc-12345", "identityId": "abc-12345", "identityDisplayName": "Example Identitydisplay", "assignmentId": "abc-12345", "identityHasRole": true, "assigned": true, "detected": true, "displayName": "Example Display", "type": "ExampleType", "typeIcon": "example-typeIcon", "owner": {"id": "abc-12345", "name": "Example Item", "displayName": "Example Display"}, "description": "A brief description.", "iiqElevatedAccess": true, "permittedBy": "example-permittedBy", "assignmentNote": "example-assignmentNote", "accountDetails": [{"value": "example-value", "application": "Example Application", "account": 1, "nativeIdentity": "example-nativeIdentity", "sourceRole": "example-sourceRole", "iiqElevatedAccess": true}], "contributingEntitlements": [{"nativeIdentity": "example-nativeIdentity", "accountName": "Example Account", "assigned": true, "grantedByRole": true, "startDate": "2024-01-01T00:00:00Z", "endDate": "2024-01-01T00:00:00Z", "lastCertDate": "2024-01-01T00:00:00Z", "lastCertName": "Example Lastcert", "lastCertificationItem": {}, "pendingCertificationItem": {}, "lastRequestItem": {}, "pendingRequestItem": {}, "assigner": "example-assigner", "source": "example-source", "foundOnAccount": true, "detectedRole": true, "hasPendingRequest": true, "pendingRequestId": "abc-12345", "allowed": true, "entitlementRequireEndDateTime": true, "entitlementMaxAccessTimeEnabled": true, "entitlementMaxAccessTimeValue": 0, "entitlementMaxAccessTimeUnit": "example-entitlementMaxAccessTimeUnit", "sourceAssignableRoleNames": ["example-value"], "sourceDetectableRoleNames": ["example-value"], "lastItem": {}, "pendingItem": {}}], "permittedRoles": [{}], "requiredRoles": [{}], "hierarchy": [{}], "hasHierarchy": true, "classificationNames": ["example-value"], "profiles": [{"name": "Example Item", "application": "Example Application", "iiqElevatedAccess": true, "constraints": ["example-value"], "permissions": [{}], "entitlements": [{}]}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/{entityId}/roleDetails/classifications':
get:
operationId: ui_ClassificationListResource_getClassifications_5
tags:
- Managed Attributes
summary: Public GET method to retrieve a ListResult of ClassificationDTOs
description: Public GET method to retrieve a ListResult of ClassificationDTOs
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/{entityId}/roleDetails/simpleEntitlements':
get:
operationId: ui_RoleDetailResource_getSimpleEntitlements_3
tags:
- Roles
summary: Returns a list of simple entitlements on the specified role
description: Returns a list of simple entitlements on the specified role
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/{entityId}/roleDetails/{managedAttributeId}/managedAttributeDetails':
get:
operationId: ui_ManagedAttributeDetailResource_getDetails_5
tags:
- Managed Attributes
summary: Get the details for the managed attribute
description: Get the details for the managed attribute
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: ManagedAttributeDetailDTO
example: {"id": "abc-12345", "application": "Example Application", "type": "ExampleType", "attribute": "example-attribute", "value": "example-value", "displayValue": "example-displayValue", "description": "A brief description.", "owner": "jsmith", "requestable": true, "iiqElevatedAccess": true, "extendedAttributes": {"key": "value"}, "groupAttributes": {"key": "value"}, "groupEntitlements": [{"nativeIdentity": "example-nativeIdentity", "accountName": "Example Account", "assigned": true, "grantedByRole": true, "startDate": "2024-01-01T00:00:00Z", "endDate": "2024-01-01T00:00:00Z", "lastCertDate": "2024-01-01T00:00:00Z", "lastCertName": "Example Lastcert", "lastCertificationItem": {}, "pendingCertificationItem": {}, "lastRequestItem": {}, "pendingRequestItem": {}, "assigner": "example-assigner", "source": "example-source", "foundOnAccount": true, "detectedRole": true, "hasPendingRequest": true, "pendingRequestId": "abc-12345", "allowed": true, "entitlementRequireEndDateTime": true, "entitlementMaxAccessTimeEnabled": true, "entitlementMaxAccessTimeValue": 0, "entitlementMaxAccessTimeUnit": "example-entitlementMaxAccessTimeUnit", "sourceAssignableRoleNames": ["example-value"], "sourceDetectableRoleNames": ["example-value"], "lastItem": {}, "pendingItem": {}}], "hasInheritance": true, "hasAccess": true, "hasMembers": true, "hasClassifications": true, "hasCloudAccess": true, "hasRoles": true}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/{entityId}/roleDetails/{managedAttributeId}/managedAttributeDetails/access':
get:
operationId: ui_TargetAssociationListResource_getAssociations_4
tags:
- Managed Attributes
summary: Get associations
description: Get associations
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/{entityId}/roleDetails/{managedAttributeId}/managedAttributeDetails/cam/group':
get:
operationId: ui_ManagedAttributeDetailResource_getGroup_5
tags:
- Managed Attributes
summary: Gets the sub resource for getting the CAM group details for this managed attribute
description: Gets the sub resource for getting the CAM group details for this managed attribute
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: CAMGroupDTO
example: {"errors": ["example-value"], "roles": [{"nativeId": "abc-12345", "cspType": "ExampleType", "displayName": "Example Display", "uri": "https://example.sailpoint.com", "adminCount": 1, "writeCount": 1, "readCount": 1, "scopes": [{}], "errors": ["example-value"], "camScopeDTO": {}}], "services": [{"name": "Example Item", "type": "ExampleType", "numResources": 0}], "uri": "https://example.sailpoint.com", "cspType": "ExampleType", "nativeId": "abc-12345", "displayName": "Example Display", "rolesList": {"items": [{}], "federatedRolesList": {}, "sb": {}}, "servicesList": {"items": [{}], "servicesList": {}, "sb": {}}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/{entityId}/roleDetails/{managedAttributeId}/managedAttributeDetails/cam/scope':
get:
operationId: ui_ManagedAttributeDetailResource_getScopeServices_5
tags:
- Managed Attributes
summary: Gets the sub resource for getting the CAM details for this managed attribute
description: Gets the sub resource for getting the CAM details for this managed attribute
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
- in: query
name: uri
required: false
description: The uri query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/{entityId}/roleDetails/{managedAttributeId}/managedAttributeDetails/cam/service':
get:
operationId: ui_CAMResourcesListResource_getServiceResources_4
tags:
- UI CAM
summary: Get the list of CAM resources
description: Get the list of CAM resources
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/{entityId}/roleDetails/{managedAttributeId}/managedAttributeDetails/classifications':
get:
operationId: ui_ClassificationListResource_getClassifications_6
tags:
- Managed Attributes
summary: Public GET method to retrieve a ListResult of ClassificationDTOs
description: Public GET method to retrieve a ListResult of ClassificationDTOs
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/{entityId}/roleDetails/{managedAttributeId}/managedAttributeDetails/inheritance/children':
get:
operationId: ui_ManagedAttributeInheritanceListResource_getChildren_4
tags:
- Managed Attributes
summary: Gets the children managed attributes based on inheritance
description: Gets the children managed attributes based on inheritance
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/{entityId}/roleDetails/{managedAttributeId}/managedAttributeDetails/inheritance/parents':
get:
operationId: ui_ManagedAttributeInheritanceListResource_getParents_4
tags:
- Managed Attributes
summary: Gets the parent managed attributes based on inheritance
description: Gets the parent managed attributes based on inheritance
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/{entityId}/roleDetails/{managedAttributeId}/managedAttributeDetails/members':
get:
operationId: ui_AccountGroupMemberListResource_getMembers_4
tags:
- UI Me
summary: Get the list of account group members
description: Get the list of account group members
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/{entityId}/roleDetails/{managedAttributeId}/managedAttributeDetails/roles':
get:
operationId: ui_AccountGroupRolesListResource_getRoles_4
tags:
- UI Approvals
summary: Get the list of associated roles for ManagedAttribute
description: Get the list of associated roles for ManagedAttribute
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/{entityId}/roleDetails/{subRoleId}/hierarchy':
get:
operationId: ui_RoleDetailResource_getHierarchy_3
tags:
- Roles
summary: Get a list of RoleDetailDTOs to represent the next level of hierarchy for the given sub role
description: Get a list of RoleDetailDTOs to represent the next level of hierarchy for the given sub role
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId path parameter.
schema:
type: string
- in: path
name: subRoleId
required: true
description: The subRoleId.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: array
items:
type: object
example: [{"id": "12345", "name": "Example Item", "description": "Sample record"}]
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/entities/{entityId}/roleSnapshotDetails':
get:
operationId: ui_CertificationEntityResource_getRoleSnapshotDetails
tags:
- UI Certifications
summary: Gets the role snapshot details represented by the certification entity
description: Gets the role snapshot details represented by the certification entity
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: entityId
required: true
description: The entityId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: RoleSnapshotDTO
example: {"displayName": "Example Display", "typeDisplayName": "Example Typedisplay", "description": "A brief description.", "scopeDisplayName": "Example Scopedisplay", "ownerDisplayName": "Example Ownerdisplay", "attr": {"key": "value"}, "attrKeys": ["example-value"], "displayableKey": "example-displayableKey", "objectAttribute": {"locale": {}, "rule": {}, "jsonPath": "/path/to/resource", "sources": [{}], "targets": [{}], "identitySelector": {}, "editMode": {}, "listenerRule": {}, "listenerWorkflow": {}, "name": "Example Item", "match": {}, "collator": {}, "source": {}, "mappedTo": "example-mappedTo", "sourceApp": {}, "src": {}, "key": "example-key"}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items':
get:
operationId: ui_CertificationItemListResource_getCertificationItems_2
tags:
- UI Certifications
summary: Get a ListResult representing certification items of specific summary status
description: Get a ListResult representing certification items of specific summary status
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: query
name: colKey
required: false
description: The colKey query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/filters':
get:
operationId: ui_CertificationItemListResource_getCertificationItemFilters_2
tags:
- UI Certifications
summary: Get the filter for these certification items
description: Get the filter for these certification items
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: array
items:
type: object
example: [{"id": "12345", "name": "Example Item", "description": "Sample record"}]
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/suggest/entitlements/names':
get:
operationId: ui_CertificationItemSuggestResource_getNames_3
tags:
- UI Certifications
summary: 'Get suggest results for the entitlement names, combining attributes and permissions'
description: 'Get suggest results for the entitlement names, combining attributes and permissions'
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: query
name: application
required: false
description: The application query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/suggest/entitlements/values':
get:
operationId: ui_CertificationItemSuggestResource_getValues_3
tags:
- UI Certifications
summary: Get suggest results for the entitlement values for the given attribute/permission name
description: Get suggest results for the entitlement values for the given attribute/permission name
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: query
name: application
required: false
description: The application query parameter.
schema:
type: string
- in: query
name: name
required: false
description: The name query parameter.
schema:
type: string
- in: query
name: isPermission
required: false
description: The isPermission query parameter.
schema:
type: boolean
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/accountDetails':
get:
operationId: ui_ApplicationAccountDetailResource_getApplicationAccountDetails_2
tags:
- UI Certifications
summary: Get a ApplicationDTO to represent the application
description: Get a ApplicationDTO to represent the application
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: ApplicationAccountDTO
example: {"application": {"id": "abc-12345", "name": "Example Item", "description": "A brief description.", "type": "ExampleType", "owner": {}, "remediators": [{}]}, "accountName": "Example Account", "nativeIdentity": "example-nativeIdentity", "linkAttributes": [{"name": "Example Item", "displayName": "Example Display", "values": [{}], "permission": true, "entitlement": true, "description": "A brief description."}], "entitlements": [{"nativeIdentity": "example-nativeIdentity", "accountName": "Example Account", "assigned": true, "grantedByRole": true, "startDate": "2024-01-01T00:00:00Z", "endDate": "2024-01-01T00:00:00Z", "lastCertDate": "2024-01-01T00:00:00Z", "lastCertName": "Example Lastcert", "lastCertificationItem": {}, "pendingCertificationItem": {}, "lastRequestItem": {}, "pendingRequestItem": {}, "assigner": "example-assigner", "source": "example-source", "foundOnAccount": true, "detectedRole": true, "hasPendingRequest": true, "pendingRequestId": "abc-12345", "allowed": true, "entitlementRequireEndDateTime": true, "entitlementMaxAccessTimeEnabled": true, "entitlementMaxAccessTimeValue": 0, "entitlementMaxAccessTimeUnit": "example-entitlementMaxAccessTimeUnit", "sourceAssignableRoleNames": ["example-value"], "sourceDetectableRoleNames": ["example-value"], "lastItem": {}, "pendingItem": {}}], "targetPermissions": [{"nativeIdentity": "example-nativeIdentity", "accountName": "Example Account", "assigned": true, "grantedByRole": true, "startDate": "2024-01-01T00:00:00Z", "endDate": "2024-01-01T00:00:00Z", "lastCertDate": "2024-01-01T00:00:00Z", "lastCertName": "Example Lastcert", "lastCertificationItem": {}, "pendingCertificationItem": {}, "lastRequestItem": {}, "pendingRequestItem": {}, "assigner": "example-assigner", "source": "example-source", "foundOnAccount": true, "detectedRole": true, "hasPendingRequest": true, "pendingRequestId": "abc-12345", "allowed": true, "entitlementRequireEndDateTime": true, "entitlementMaxAccessTimeEnabled": true, "entitlementMaxAccessTimeValue": 0, "entitlementMaxAccessTimeUnit": "example-entitlementMaxAccessTimeUnit", "sourceAssignableRoleNames": ["example-value"], "sourceDetectableRoleNames": ["example-value"], "lastItem": {}, "pendingItem": {}}], "iiqElevatedAccess": true}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/accountDetails/{managedAttributeId}/managedAttributeDetails':
get:
operationId: ui_ManagedAttributeDetailResource_getDetails_6
tags:
- Managed Attributes
summary: Get the details for the managed attribute
description: Get the details for the managed attribute
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: ManagedAttributeDetailDTO
example: {"id": "abc-12345", "application": "Example Application", "type": "ExampleType", "attribute": "example-attribute", "value": "example-value", "displayValue": "example-displayValue", "description": "A brief description.", "owner": "jsmith", "requestable": true, "iiqElevatedAccess": true, "extendedAttributes": {"key": "value"}, "groupAttributes": {"key": "value"}, "groupEntitlements": [{"nativeIdentity": "example-nativeIdentity", "accountName": "Example Account", "assigned": true, "grantedByRole": true, "startDate": "2024-01-01T00:00:00Z", "endDate": "2024-01-01T00:00:00Z", "lastCertDate": "2024-01-01T00:00:00Z", "lastCertName": "Example Lastcert", "lastCertificationItem": {}, "pendingCertificationItem": {}, "lastRequestItem": {}, "pendingRequestItem": {}, "assigner": "example-assigner", "source": "example-source", "foundOnAccount": true, "detectedRole": true, "hasPendingRequest": true, "pendingRequestId": "abc-12345", "allowed": true, "entitlementRequireEndDateTime": true, "entitlementMaxAccessTimeEnabled": true, "entitlementMaxAccessTimeValue": 0, "entitlementMaxAccessTimeUnit": "example-entitlementMaxAccessTimeUnit", "sourceAssignableRoleNames": ["example-value"], "sourceDetectableRoleNames": ["example-value"], "lastItem": {}, "pendingItem": {}}], "hasInheritance": true, "hasAccess": true, "hasMembers": true, "hasClassifications": true, "hasCloudAccess": true, "hasRoles": true}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/accountDetails/{managedAttributeId}/managedAttributeDetails/access':
get:
operationId: ui_TargetAssociationListResource_getAssociations_5
tags:
- Managed Attributes
summary: Get associations
description: Get associations
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/accountDetails/{managedAttributeId}/managedAttributeDetails/cam/group':
get:
operationId: ui_ManagedAttributeDetailResource_getGroup_6
tags:
- Managed Attributes
summary: Gets the sub resource for getting the CAM group details for this managed attribute
description: Gets the sub resource for getting the CAM group details for this managed attribute
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: CAMGroupDTO
example: {"errors": ["example-value"], "roles": [{"nativeId": "abc-12345", "cspType": "ExampleType", "displayName": "Example Display", "uri": "https://example.sailpoint.com", "adminCount": 1, "writeCount": 1, "readCount": 1, "scopes": [{}], "errors": ["example-value"], "camScopeDTO": {}}], "services": [{"name": "Example Item", "type": "ExampleType", "numResources": 0}], "uri": "https://example.sailpoint.com", "cspType": "ExampleType", "nativeId": "abc-12345", "displayName": "Example Display", "rolesList": {"items": [{}], "federatedRolesList": {}, "sb": {}}, "servicesList": {"items": [{}], "servicesList": {}, "sb": {}}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/accountDetails/{managedAttributeId}/managedAttributeDetails/cam/scope':
get:
operationId: ui_ManagedAttributeDetailResource_getScopeServices_6
tags:
- Managed Attributes
summary: Gets the sub resource for getting the CAM details for this managed attribute
description: Gets the sub resource for getting the CAM details for this managed attribute
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
- in: query
name: uri
required: false
description: The uri query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/accountDetails/{managedAttributeId}/managedAttributeDetails/cam/service':
get:
operationId: ui_CAMResourcesListResource_getServiceResources_5
tags:
- UI CAM
summary: Get the list of CAM resources
description: Get the list of CAM resources
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/accountDetails/{managedAttributeId}/managedAttributeDetails/classifications':
get:
operationId: ui_ClassificationListResource_getClassifications_7
tags:
- Managed Attributes
summary: Public GET method to retrieve a ListResult of ClassificationDTOs
description: Public GET method to retrieve a ListResult of ClassificationDTOs
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/accountDetails/{managedAttributeId}/managedAttributeDetails/inheritance/children':
get:
operationId: ui_ManagedAttributeInheritanceListResource_getChildren_5
tags:
- Managed Attributes
summary: Gets the children managed attributes based on inheritance
description: Gets the children managed attributes based on inheritance
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/accountDetails/{managedAttributeId}/managedAttributeDetails/inheritance/parents':
get:
operationId: ui_ManagedAttributeInheritanceListResource_getParents_5
tags:
- Managed Attributes
summary: Gets the parent managed attributes based on inheritance
description: Gets the parent managed attributes based on inheritance
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/accountDetails/{managedAttributeId}/managedAttributeDetails/members':
get:
operationId: ui_AccountGroupMemberListResource_getMembers_5
tags:
- UI Me
summary: Get the list of account group members
description: Get the list of account group members
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/accountDetails/{managedAttributeId}/managedAttributeDetails/roles':
get:
operationId: ui_AccountGroupRolesListResource_getRoles_5
tags:
- UI Approvals
summary: Get the list of associated roles for ManagedAttribute
description: Get the list of associated roles for ManagedAttribute
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/comment':
post:
operationId: ui_CertificationItemResource_postEntitlementComment_2
tags:
- UI Certifications
summary: 'Add an entitlement comment to the identity''s history'
description: 'Add an entitlement comment to the identity''s history'
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"entityDecision": "example-entityDecision", "itemType": "Identity", "recipient": "example-recipient", "remediationDetails": "example-remediationDetails", "selectionCriteria": "name sw \"example\"", "status": "Active"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/delegationDescription':
get:
operationId: ui_CertificationItemResource_getDelegationDescription_2
tags:
- UI Certifications
summary: Get the delegation description for this certification item
description: Get the delegation description for this certification item
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: DecisionSummary
example: {"id": "abc-12345", "itemType": {}, "owner": {"id": "abc-12345", "name": "Example Item", "displayName": "Example Display"}, "defaultRemediator": {"id": "abc-12345", "name": "Example Item", "displayName": "Example Display"}, "enableOverrideDefaultRemediator": true, "description": "A brief description.", "comments": "example-comments", "violationConstraint": "example-violationConstraint", "violationSummary": "example-violationSummary", "remediationAdvice": "example-remediationAdvice", "assignmentOptions": [{}], "mitigationExpiration": 0, "provisioners": ["example-value"], "remediationDetails": [{"id": 0, "account": 1, "nativeIdentity": "example-nativeIdentity", "application": "Example Application", "applicationId": "abc-12345", "attribute": "example-attribute", "attributeValue": "example-attributeValue", "permissionTarget": "example-permissionTarget", "permissionRights": ["example-value"], "editable": true, "canChangeValue": true, "inputType": "ExampleType", "selectOptions": [{}], "operation": ["example-value"], "existingRemediation": true, "attributeDisplayValue": "example-attributeDisplayValue", "newValue": "example-newValue", "newOperation": "example-newOperation", "qo": {}, "appResult": ["example-value"], "defaultRemediationModifiableOp": "example-defaultRemediationModifiableOp"}], "useManagedAttributesForRemediation": true, "delegation": {}, "entityDelegation": {}, "additionalRoles": ["example-value"], "requiredOrPermittedRoles": ["example-value"], "completionComments": "example-completionComments", "violationDetailer": {"violation": {}, "policy": {}, "policyName": "Example Policy", "policyType": "ExampleType", "id": "abc-12345", "compensatingControl": "example-compensatingControl", "constraintDescription": "A brief description.", "constraintWeight": "example-constraintWeight", "constraint": "example-constraint", "constraintPolicy": "example-constraintPolicy", "remediationAdvice": "example-remediationAdvice", "summary": "example-summary", "sodConflict": "example-sodConflict", "status": "Active", "renderer": "example-renderer", "createdDate": "2024-01-01T00:00:00Z", "args": {"key": "value"}, "activity": {}, "identityName": "Example Identity", "identityFirstname": "Example Identityfirst", "identityLastname": "Example Identitylast", "identityId": "abc-12345", "ownerName": "Example Owner", "lastDecision": {}, "lastDecisionFound": true, "base": {}, "identity": {}, "localizer": {}, "left": "example-left", "right": "example-right", "msg": {}, "builder": {}, "decision": {}}, "delegationOwner": {"objectConfig": {}, "systemAttributes": {"key": "value"}, "links": [{}], "detectedRoles": [{}], "assignedRoles": [{}], "roleMetadatas": [{}], "exceptions": [{}], "mitigationExpirations": [{}], "preferences": {"key": "value"}, "manager": {}, "capabilities": [{}], "controlledScopes": [{}], "controlsAssignedScope": true, "password": "**hidden**", "scorecard": {}, "lastLogin": "example-lastLogin", "lastRefresh": "example-lastRefresh", "activityConfig": {}, "capabilityManager": {}, "authApplication": {}, "authAccount": {}, "identityEntitlements": [{}], "correlatedOverridden": true, "flattenedRights": {}, "effectiveRights": {}, "bundleSummary": "example-bundleSummary", "assignedRoleSummary": "example-assignedRoleSummary", "attributes": {"key": "value"}, "uiPreferences": {}, "passwordExpiration": "example-passwordExpiration", "passwordHistory": "example-passwordHistory", "authenticationAnswers": [{}], "authLockStart": "example-authLockStart", "certifications": [{}], "workgroups": [{}], "administrator": {}, "extendedIdentity1": {}, "extendedIdentity2": {}, "extendedIdentity3": {}, "extendedIdentity4": {}, "extendedIdentity5": {}, "config": {}, "value": "example-value", "name": "Example Item", "key": "example-key", "buildList": [{}], "def": {}, "sources": [{}], "metadata": {}, "displayName": "Example Display", "custom": {"key": "value"}, "keys": ["example-value"], "atts": {"key": "value"}, "attributeDefinition": {}, "result": {}, "attr": "example-attr", "found": [{}], "linkInstance": "example-linkInstance", "displayNameFound": {}, "uuidFound": {}, "uuid": "abc-12345", "id": "abc-12345", "appname": "Example App", "identity": "example-identity", "composite": {}, "composites": [{}], "collection": {}, "attrs": {"key": "value"}, "es": {}, "assignedAndDetectedRoles": [{}], "inheritance": [{}], "requirements": [{}], "summary": "example-summary", "buf": {}, "bundles": [{}], "existingMetadata": {}, "appId": "abc-12345", "it": {}, "l": {}, "link": {}, "d": "example-d", "last": "example-last", "certLinks": {}, "svc": {}, "historyItem": {}, "snapshots": {"key": "value"}, "caps": [{}], "directRights": ["example-value"], "indirectRights": ["example-value"], "effective": [{}], "localCaps": [{}], "indirect": [{}], "capNames": ["example-value"], "scopes": [{}], "groups": [{}], "wgScopes": [{}], "scopeIt": {}, "distinctScopes": [{}], "scope": {}, "childScopes": [{}], "scopeNames": ["example-value"], "val": "example-val", "current": [{}], "ass": {}, "assignments": [{}], "o": "example-o", "assign": {}, "as": {}, "roles": [{}], "list": [{}], "negativeAssignments": [{}], "active": [{}], "foundAssignments": [{}], "match": {}, "assignment": {}, "requests": [{}], "appRoleDetects": [{}], "filteredDetections": [{}], "detections": [{}], "det": {}, "otherId": "abc-12345", "unassignedDetection": {}, "mappings": {"key": "value"}, "role": {}, "ents": [{}], "comparator": {}, "appCerts": {"key": "value"}, "conflictingCert": {}, "certLinkArray": [{}], "triggers": {"key": "value"}, "standardAttributeNames": ["example-value"], "type": {}}, "map": {"key": "value"}, "identity": {"id": "abc-12345", "name": "Example Item", "displayName": "Example Display"}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/history':
get:
operationId: ui_CertificationItemResource_getIdentityHistory_2
tags:
- UI Certifications
summary: Get the identity history result data from the identity history list service and add in the temp decision if there is no history data found
description: Get the identity history result data from the identity history list service and add in the temp decision if there is no history data found
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/identityAttributes':
get:
operationId: ui_CertificationItemResource_getIdentityAttributes_2
tags:
- UI Certifications
summary: Returns IdentityAttributesDTO for certification item
description: Returns IdentityAttributesDTO for certification item
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: IdentityAttributesDTO
example: {"attributeName": "Example Attribute", "label": "example-label", "value": "example-value", "authorizedToView": true, "attributes": [{}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/linkAttributes':
get:
operationId: ui_CertificationItemResource_getLinkAttributes_2
tags:
- UI Certifications
summary: Returns LinkAttributesDTOs for the identity on the certification item uses start and limit query parameters
description: Returns LinkAttributesDTOs for the identity on the certification item uses start and limit query parameters
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/managedAttributeDetails':
get:
operationId: ui_ManagedAttributeDetailResource_getDetails_7
tags:
- Managed Attributes
summary: Get the details for the managed attribute
description: Get the details for the managed attribute
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: ManagedAttributeDetailDTO
example: {"id": "abc-12345", "application": "Example Application", "type": "ExampleType", "attribute": "example-attribute", "value": "example-value", "displayValue": "example-displayValue", "description": "A brief description.", "owner": "jsmith", "requestable": true, "iiqElevatedAccess": true, "extendedAttributes": {"key": "value"}, "groupAttributes": {"key": "value"}, "groupEntitlements": [{"nativeIdentity": "example-nativeIdentity", "accountName": "Example Account", "assigned": true, "grantedByRole": true, "startDate": "2024-01-01T00:00:00Z", "endDate": "2024-01-01T00:00:00Z", "lastCertDate": "2024-01-01T00:00:00Z", "lastCertName": "Example Lastcert", "lastCertificationItem": {}, "pendingCertificationItem": {}, "lastRequestItem": {}, "pendingRequestItem": {}, "assigner": "example-assigner", "source": "example-source", "foundOnAccount": true, "detectedRole": true, "hasPendingRequest": true, "pendingRequestId": "abc-12345", "allowed": true, "entitlementRequireEndDateTime": true, "entitlementMaxAccessTimeEnabled": true, "entitlementMaxAccessTimeValue": 0, "entitlementMaxAccessTimeUnit": "example-entitlementMaxAccessTimeUnit", "sourceAssignableRoleNames": ["example-value"], "sourceDetectableRoleNames": ["example-value"], "lastItem": {}, "pendingItem": {}}], "hasInheritance": true, "hasAccess": true, "hasMembers": true, "hasClassifications": true, "hasCloudAccess": true, "hasRoles": true}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/managedAttributeDetails/access':
get:
operationId: ui_TargetAssociationListResource_getAssociations_6
tags:
- Managed Attributes
summary: Get associations
description: Get associations
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/managedAttributeDetails/cam/group':
get:
operationId: ui_ManagedAttributeDetailResource_getGroup_7
tags:
- Managed Attributes
summary: Gets the sub resource for getting the CAM group details for this managed attribute
description: Gets the sub resource for getting the CAM group details for this managed attribute
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: CAMGroupDTO
example: {"errors": ["example-value"], "roles": [{"nativeId": "abc-12345", "cspType": "ExampleType", "displayName": "Example Display", "uri": "https://example.sailpoint.com", "adminCount": 1, "writeCount": 1, "readCount": 1, "scopes": [{}], "errors": ["example-value"], "camScopeDTO": {}}], "services": [{"name": "Example Item", "type": "ExampleType", "numResources": 0}], "uri": "https://example.sailpoint.com", "cspType": "ExampleType", "nativeId": "abc-12345", "displayName": "Example Display", "rolesList": {"items": [{}], "federatedRolesList": {}, "sb": {}}, "servicesList": {"items": [{}], "servicesList": {}, "sb": {}}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/managedAttributeDetails/cam/scope':
get:
operationId: ui_ManagedAttributeDetailResource_getScopeServices_7
tags:
- Managed Attributes
summary: Gets the sub resource for getting the CAM details for this managed attribute
description: Gets the sub resource for getting the CAM details for this managed attribute
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: query
name: uri
required: false
description: The uri query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/managedAttributeDetails/cam/service':
get:
operationId: ui_CAMResourcesListResource_getServiceResources_6
tags:
- UI CAM
summary: Get the list of CAM resources
description: Get the list of CAM resources
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/managedAttributeDetails/classifications':
get:
operationId: ui_ClassificationListResource_getClassifications_8
tags:
- Managed Attributes
summary: Public GET method to retrieve a ListResult of ClassificationDTOs
description: Public GET method to retrieve a ListResult of ClassificationDTOs
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/managedAttributeDetails/inheritance/children':
get:
operationId: ui_ManagedAttributeInheritanceListResource_getChildren_6
tags:
- Managed Attributes
summary: Gets the children managed attributes based on inheritance
description: Gets the children managed attributes based on inheritance
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/managedAttributeDetails/inheritance/parents':
get:
operationId: ui_ManagedAttributeInheritanceListResource_getParents_6
tags:
- Managed Attributes
summary: Gets the parent managed attributes based on inheritance
description: Gets the parent managed attributes based on inheritance
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/managedAttributeDetails/members':
get:
operationId: ui_AccountGroupMemberListResource_getMembers_6
tags:
- UI Me
summary: Get the list of account group members
description: Get the list of account group members
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/managedAttributeDetails/roles':
get:
operationId: ui_AccountGroupRolesListResource_getRoles_6
tags:
- UI Approvals
summary: Get the list of associated roles for ManagedAttribute
description: Get the list of associated roles for ManagedAttribute
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/remediationAdvice':
get:
operationId: ui_CertificationItemResource_getViolationRemediationAdvice_2
tags:
- UI Certifications
summary: Get the remediation advice for this certification item
description: Get the remediation advice for this certification item
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: RemediationAdviceResult
example: {"advice": {"violationConstraint": "example-violationConstraint", "violationSummary": "example-violationSummary", "remediationAdvice": "example-remediationAdvice", "rightRoles": [{}], "leftRoles": [{}], "entitlementsToRemediate": {}, "map": {"key": "value"}, "name": "Example Item", "result": {"key": "value"}, "description": "A brief description."}, "summary": {"id": "abc-12345", "itemType": {}, "owner": {}, "defaultRemediator": {}, "enableOverrideDefaultRemediator": true, "description": "A brief description.", "comments": "example-comments", "violationConstraint": "example-violationConstraint", "violationSummary": "example-violationSummary", "remediationAdvice": "example-remediationAdvice", "assignmentOptions": [{}], "mitigationExpiration": 0, "provisioners": ["example-value"], "remediationDetails": [{}], "useManagedAttributesForRemediation": true, "delegation": {}, "entityDelegation": {}, "additionalRoles": ["example-value"], "requiredOrPermittedRoles": ["example-value"], "completionComments": "example-completionComments", "violationDetailer": {}, "delegationOwner": {}, "map": {"key": "value"}, "identity": {}}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/remediationSummary':
post:
operationId: ui_CertificationItemResource_getRemediationSummary_2
tags:
- UI Certifications
summary: Gets the remediation summary for this certification item
description: Gets the remediation summary for this certification item
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"entityDecision": "example-entityDecision", "itemType": "Identity", "recipient": "example-recipient", "remediationDetails": "example-remediationDetails", "selectionCriteria": "name sw \"example\"", "status": "Active"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: DecisionSummary
example: {"id": "abc-12345", "itemType": {}, "owner": {"id": "abc-12345", "name": "Example Item", "displayName": "Example Display"}, "defaultRemediator": {"id": "abc-12345", "name": "Example Item", "displayName": "Example Display"}, "enableOverrideDefaultRemediator": true, "description": "A brief description.", "comments": "example-comments", "violationConstraint": "example-violationConstraint", "violationSummary": "example-violationSummary", "remediationAdvice": "example-remediationAdvice", "assignmentOptions": [{}], "mitigationExpiration": 0, "provisioners": ["example-value"], "remediationDetails": [{"id": 0, "account": 1, "nativeIdentity": "example-nativeIdentity", "application": "Example Application", "applicationId": "abc-12345", "attribute": "example-attribute", "attributeValue": "example-attributeValue", "permissionTarget": "example-permissionTarget", "permissionRights": ["example-value"], "editable": true, "canChangeValue": true, "inputType": "ExampleType", "selectOptions": [{}], "operation": ["example-value"], "existingRemediation": true, "attributeDisplayValue": "example-attributeDisplayValue", "newValue": "example-newValue", "newOperation": "example-newOperation", "qo": {}, "appResult": ["example-value"], "defaultRemediationModifiableOp": "example-defaultRemediationModifiableOp"}], "useManagedAttributesForRemediation": true, "delegation": {}, "entityDelegation": {}, "additionalRoles": ["example-value"], "requiredOrPermittedRoles": ["example-value"], "completionComments": "example-completionComments", "violationDetailer": {"violation": {}, "policy": {}, "policyName": "Example Policy", "policyType": "ExampleType", "id": "abc-12345", "compensatingControl": "example-compensatingControl", "constraintDescription": "A brief description.", "constraintWeight": "example-constraintWeight", "constraint": "example-constraint", "constraintPolicy": "example-constraintPolicy", "remediationAdvice": "example-remediationAdvice", "summary": "example-summary", "sodConflict": "example-sodConflict", "status": "Active", "renderer": "example-renderer", "createdDate": "2024-01-01T00:00:00Z", "args": {"key": "value"}, "activity": {}, "identityName": "Example Identity", "identityFirstname": "Example Identityfirst", "identityLastname": "Example Identitylast", "identityId": "abc-12345", "ownerName": "Example Owner", "lastDecision": {}, "lastDecisionFound": true, "base": {}, "identity": {}, "localizer": {}, "left": "example-left", "right": "example-right", "msg": {}, "builder": {}, "decision": {}}, "delegationOwner": {"objectConfig": {}, "systemAttributes": {"key": "value"}, "links": [{}], "detectedRoles": [{}], "assignedRoles": [{}], "roleMetadatas": [{}], "exceptions": [{}], "mitigationExpirations": [{}], "preferences": {"key": "value"}, "manager": {}, "capabilities": [{}], "controlledScopes": [{}], "controlsAssignedScope": true, "password": "**hidden**", "scorecard": {}, "lastLogin": "example-lastLogin", "lastRefresh": "example-lastRefresh", "activityConfig": {}, "capabilityManager": {}, "authApplication": {}, "authAccount": {}, "identityEntitlements": [{}], "correlatedOverridden": true, "flattenedRights": {}, "effectiveRights": {}, "bundleSummary": "example-bundleSummary", "assignedRoleSummary": "example-assignedRoleSummary", "attributes": {"key": "value"}, "uiPreferences": {}, "passwordExpiration": "example-passwordExpiration", "passwordHistory": "example-passwordHistory", "authenticationAnswers": [{}], "authLockStart": "example-authLockStart", "certifications": [{}], "workgroups": [{}], "administrator": {}, "extendedIdentity1": {}, "extendedIdentity2": {}, "extendedIdentity3": {}, "extendedIdentity4": {}, "extendedIdentity5": {}, "config": {}, "value": "example-value", "name": "Example Item", "key": "example-key", "buildList": [{}], "def": {}, "sources": [{}], "metadata": {}, "displayName": "Example Display", "custom": {"key": "value"}, "keys": ["example-value"], "atts": {"key": "value"}, "attributeDefinition": {}, "result": {}, "attr": "example-attr", "found": [{}], "linkInstance": "example-linkInstance", "displayNameFound": {}, "uuidFound": {}, "uuid": "abc-12345", "id": "abc-12345", "appname": "Example App", "identity": "example-identity", "composite": {}, "composites": [{}], "collection": {}, "attrs": {"key": "value"}, "es": {}, "assignedAndDetectedRoles": [{}], "inheritance": [{}], "requirements": [{}], "summary": "example-summary", "buf": {}, "bundles": [{}], "existingMetadata": {}, "appId": "abc-12345", "it": {}, "l": {}, "link": {}, "d": "example-d", "last": "example-last", "certLinks": {}, "svc": {}, "historyItem": {}, "snapshots": {"key": "value"}, "caps": [{}], "directRights": ["example-value"], "indirectRights": ["example-value"], "effective": [{}], "localCaps": [{}], "indirect": [{}], "capNames": ["example-value"], "scopes": [{}], "groups": [{}], "wgScopes": [{}], "scopeIt": {}, "distinctScopes": [{}], "scope": {}, "childScopes": [{}], "scopeNames": ["example-value"], "val": "example-val", "current": [{}], "ass": {}, "assignments": [{}], "o": "example-o", "assign": {}, "as": {}, "roles": [{}], "list": [{}], "negativeAssignments": [{}], "active": [{}], "foundAssignments": [{}], "match": {}, "assignment": {}, "requests": [{}], "appRoleDetects": [{}], "filteredDetections": [{}], "detections": [{}], "det": {}, "otherId": "abc-12345", "unassignedDetection": {}, "mappings": {"key": "value"}, "role": {}, "ents": [{}], "comparator": {}, "appCerts": {"key": "value"}, "conflictingCert": {}, "certLinkArray": [{}], "triggers": {"key": "value"}, "standardAttributeNames": ["example-value"], "type": {}}, "map": {"key": "value"}, "identity": {"id": "abc-12345", "name": "Example Item", "displayName": "Example Display"}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/roleDetails':
get:
operationId: ui_RoleDetailResource_getDetails_4
tags:
- Roles
summary: Get a RoleDetailDTO to represent to current role
description: Get a RoleDetailDTO to represent to current role
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: RoleDetailDTO
example: {"id": "abc-12345", "identityId": "abc-12345", "identityDisplayName": "Example Identitydisplay", "assignmentId": "abc-12345", "identityHasRole": true, "assigned": true, "detected": true, "displayName": "Example Display", "type": "ExampleType", "typeIcon": "example-typeIcon", "owner": {"id": "abc-12345", "name": "Example Item", "displayName": "Example Display"}, "description": "A brief description.", "iiqElevatedAccess": true, "permittedBy": "example-permittedBy", "assignmentNote": "example-assignmentNote", "accountDetails": [{"value": "example-value", "application": "Example Application", "account": 1, "nativeIdentity": "example-nativeIdentity", "sourceRole": "example-sourceRole", "iiqElevatedAccess": true}], "contributingEntitlements": [{"nativeIdentity": "example-nativeIdentity", "accountName": "Example Account", "assigned": true, "grantedByRole": true, "startDate": "2024-01-01T00:00:00Z", "endDate": "2024-01-01T00:00:00Z", "lastCertDate": "2024-01-01T00:00:00Z", "lastCertName": "Example Lastcert", "lastCertificationItem": {}, "pendingCertificationItem": {}, "lastRequestItem": {}, "pendingRequestItem": {}, "assigner": "example-assigner", "source": "example-source", "foundOnAccount": true, "detectedRole": true, "hasPendingRequest": true, "pendingRequestId": "abc-12345", "allowed": true, "entitlementRequireEndDateTime": true, "entitlementMaxAccessTimeEnabled": true, "entitlementMaxAccessTimeValue": 0, "entitlementMaxAccessTimeUnit": "example-entitlementMaxAccessTimeUnit", "sourceAssignableRoleNames": ["example-value"], "sourceDetectableRoleNames": ["example-value"], "lastItem": {}, "pendingItem": {}}], "permittedRoles": [{}], "requiredRoles": [{}], "hierarchy": [{}], "hasHierarchy": true, "classificationNames": ["example-value"], "profiles": [{"name": "Example Item", "application": "Example Application", "iiqElevatedAccess": true, "constraints": ["example-value"], "permissions": [{}], "entitlements": [{}]}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/roleDetails/classifications':
get:
operationId: ui_ClassificationListResource_getClassifications_9
tags:
- Managed Attributes
summary: Public GET method to retrieve a ListResult of ClassificationDTOs
description: Public GET method to retrieve a ListResult of ClassificationDTOs
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/roleDetails/simpleEntitlements':
get:
operationId: ui_RoleDetailResource_getSimpleEntitlements_4
tags:
- Roles
summary: Returns a list of simple entitlements on the specified role
description: Returns a list of simple entitlements on the specified role
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/roleDetails/{managedAttributeId}/managedAttributeDetails':
get:
operationId: ui_ManagedAttributeDetailResource_getDetails_8
tags:
- Managed Attributes
summary: Get the details for the managed attribute
description: Get the details for the managed attribute
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: ManagedAttributeDetailDTO
example: {"id": "abc-12345", "application": "Example Application", "type": "ExampleType", "attribute": "example-attribute", "value": "example-value", "displayValue": "example-displayValue", "description": "A brief description.", "owner": "jsmith", "requestable": true, "iiqElevatedAccess": true, "extendedAttributes": {"key": "value"}, "groupAttributes": {"key": "value"}, "groupEntitlements": [{"nativeIdentity": "example-nativeIdentity", "accountName": "Example Account", "assigned": true, "grantedByRole": true, "startDate": "2024-01-01T00:00:00Z", "endDate": "2024-01-01T00:00:00Z", "lastCertDate": "2024-01-01T00:00:00Z", "lastCertName": "Example Lastcert", "lastCertificationItem": {}, "pendingCertificationItem": {}, "lastRequestItem": {}, "pendingRequestItem": {}, "assigner": "example-assigner", "source": "example-source", "foundOnAccount": true, "detectedRole": true, "hasPendingRequest": true, "pendingRequestId": "abc-12345", "allowed": true, "entitlementRequireEndDateTime": true, "entitlementMaxAccessTimeEnabled": true, "entitlementMaxAccessTimeValue": 0, "entitlementMaxAccessTimeUnit": "example-entitlementMaxAccessTimeUnit", "sourceAssignableRoleNames": ["example-value"], "sourceDetectableRoleNames": ["example-value"], "lastItem": {}, "pendingItem": {}}], "hasInheritance": true, "hasAccess": true, "hasMembers": true, "hasClassifications": true, "hasCloudAccess": true, "hasRoles": true}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/roleDetails/{managedAttributeId}/managedAttributeDetails/access':
get:
operationId: ui_TargetAssociationListResource_getAssociations_7
tags:
- Managed Attributes
summary: Get associations
description: Get associations
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/roleDetails/{managedAttributeId}/managedAttributeDetails/cam/group':
get:
operationId: ui_ManagedAttributeDetailResource_getGroup_8
tags:
- Managed Attributes
summary: Gets the sub resource for getting the CAM group details for this managed attribute
description: Gets the sub resource for getting the CAM group details for this managed attribute
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: CAMGroupDTO
example: {"errors": ["example-value"], "roles": [{"nativeId": "abc-12345", "cspType": "ExampleType", "displayName": "Example Display", "uri": "https://example.sailpoint.com", "adminCount": 1, "writeCount": 1, "readCount": 1, "scopes": [{}], "errors": ["example-value"], "camScopeDTO": {}}], "services": [{"name": "Example Item", "type": "ExampleType", "numResources": 0}], "uri": "https://example.sailpoint.com", "cspType": "ExampleType", "nativeId": "abc-12345", "displayName": "Example Display", "rolesList": {"items": [{}], "federatedRolesList": {}, "sb": {}}, "servicesList": {"items": [{}], "servicesList": {}, "sb": {}}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/roleDetails/{managedAttributeId}/managedAttributeDetails/cam/scope':
get:
operationId: ui_ManagedAttributeDetailResource_getScopeServices_8
tags:
- Managed Attributes
summary: Gets the sub resource for getting the CAM details for this managed attribute
description: Gets the sub resource for getting the CAM details for this managed attribute
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
- in: query
name: uri
required: false
description: The uri query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/roleDetails/{managedAttributeId}/managedAttributeDetails/cam/service':
get:
operationId: ui_CAMResourcesListResource_getServiceResources_7
tags:
- UI CAM
summary: Get the list of CAM resources
description: Get the list of CAM resources
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/roleDetails/{managedAttributeId}/managedAttributeDetails/classifications':
get:
operationId: ui_ClassificationListResource_getClassifications_10
tags:
- Managed Attributes
summary: Public GET method to retrieve a ListResult of ClassificationDTOs
description: Public GET method to retrieve a ListResult of ClassificationDTOs
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/roleDetails/{managedAttributeId}/managedAttributeDetails/inheritance/children':
get:
operationId: ui_ManagedAttributeInheritanceListResource_getChildren_7
tags:
- Managed Attributes
summary: Gets the children managed attributes based on inheritance
description: Gets the children managed attributes based on inheritance
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/roleDetails/{managedAttributeId}/managedAttributeDetails/inheritance/parents':
get:
operationId: ui_ManagedAttributeInheritanceListResource_getParents_7
tags:
- Managed Attributes
summary: Gets the parent managed attributes based on inheritance
description: Gets the parent managed attributes based on inheritance
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/roleDetails/{managedAttributeId}/managedAttributeDetails/members':
get:
operationId: ui_AccountGroupMemberListResource_getMembers_7
tags:
- UI Me
summary: Get the list of account group members
description: Get the list of account group members
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/roleDetails/{managedAttributeId}/managedAttributeDetails/roles':
get:
operationId: ui_AccountGroupRolesListResource_getRoles_7
tags:
- UI Approvals
summary: Get the list of associated roles for ManagedAttribute
description: Get the list of associated roles for ManagedAttribute
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/roleDetails/{subRoleId}/hierarchy':
get:
operationId: ui_RoleDetailResource_getHierarchy_4
tags:
- Roles
summary: Get a list of RoleDetailDTOs to represent the next level of hierarchy for the given sub role
description: Get a list of RoleDetailDTOs to represent the next level of hierarchy for the given sub role
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: subRoleId
required: true
description: The subRoleId.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: array
items:
type: object
example: [{"id": "12345", "name": "Example Item", "description": "Sample record"}]
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/roleProfile':
get:
operationId: ui_CertificationItemProfileResource_getRoleProfileDTO_2
tags:
- UI Certifications
summary: Returns the RoleProfile details for the given CertificationItem
description: Returns the RoleProfile details for the given CertificationItem
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: RoleProfileDTO
example: {"name": "Example Item", "application": "Example Application", "iiqElevatedAccess": true, "constraints": ["example-value"], "permissions": [{"target": "example-target", "rights": "example-rights", "iiqElevatedAccess": true}], "entitlements": [{"application": "Example Application", "applicationId": "abc-12345", "attribute": "example-attribute", "name": "Example Item", "value": "example-value", "displayValue": "example-displayValue", "description": "A brief description.", "group": true, "permission": true, "annotation": "example-annotation", "localizedType": "ExampleType", "iiqEntitlement": true, "managedAttributeId": "abc-12345", "classificationNames": ["example-value"], "iiqElevatedAccess": true, "app": {}, "managedAttribute": {}}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/roleProfile/managedAttributeDetails/{managedAttributeId}':
get:
operationId: ui_ManagedAttributeDetailResource_getDetails_9
tags:
- Managed Attributes
summary: Get the details for the managed attribute
description: Get the details for the managed attribute
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: ManagedAttributeDetailDTO
example: {"id": "abc-12345", "application": "Example Application", "type": "ExampleType", "attribute": "example-attribute", "value": "example-value", "displayValue": "example-displayValue", "description": "A brief description.", "owner": "jsmith", "requestable": true, "iiqElevatedAccess": true, "extendedAttributes": {"key": "value"}, "groupAttributes": {"key": "value"}, "groupEntitlements": [{"nativeIdentity": "example-nativeIdentity", "accountName": "Example Account", "assigned": true, "grantedByRole": true, "startDate": "2024-01-01T00:00:00Z", "endDate": "2024-01-01T00:00:00Z", "lastCertDate": "2024-01-01T00:00:00Z", "lastCertName": "Example Lastcert", "lastCertificationItem": {}, "pendingCertificationItem": {}, "lastRequestItem": {}, "pendingRequestItem": {}, "assigner": "example-assigner", "source": "example-source", "foundOnAccount": true, "detectedRole": true, "hasPendingRequest": true, "pendingRequestId": "abc-12345", "allowed": true, "entitlementRequireEndDateTime": true, "entitlementMaxAccessTimeEnabled": true, "entitlementMaxAccessTimeValue": 0, "entitlementMaxAccessTimeUnit": "example-entitlementMaxAccessTimeUnit", "sourceAssignableRoleNames": ["example-value"], "sourceDetectableRoleNames": ["example-value"], "lastItem": {}, "pendingItem": {}}], "hasInheritance": true, "hasAccess": true, "hasMembers": true, "hasClassifications": true, "hasCloudAccess": true, "hasRoles": true}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/roleProfile/managedAttributeDetails/{managedAttributeId}/access':
get:
operationId: ui_TargetAssociationListResource_getAssociations_8
tags:
- Managed Attributes
summary: Get associations
description: Get associations
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/roleProfile/managedAttributeDetails/{managedAttributeId}/cam/group':
get:
operationId: ui_ManagedAttributeDetailResource_getGroup_9
tags:
- Managed Attributes
summary: Gets the sub resource for getting the CAM group details for this managed attribute
description: Gets the sub resource for getting the CAM group details for this managed attribute
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: CAMGroupDTO
example: {"errors": ["example-value"], "roles": [{"nativeId": "abc-12345", "cspType": "ExampleType", "displayName": "Example Display", "uri": "https://example.sailpoint.com", "adminCount": 1, "writeCount": 1, "readCount": 1, "scopes": [{}], "errors": ["example-value"], "camScopeDTO": {}}], "services": [{"name": "Example Item", "type": "ExampleType", "numResources": 0}], "uri": "https://example.sailpoint.com", "cspType": "ExampleType", "nativeId": "abc-12345", "displayName": "Example Display", "rolesList": {"items": [{}], "federatedRolesList": {}, "sb": {}}, "servicesList": {"items": [{}], "servicesList": {}, "sb": {}}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/roleProfile/managedAttributeDetails/{managedAttributeId}/cam/scope':
get:
operationId: ui_ManagedAttributeDetailResource_getScopeServices_9
tags:
- Managed Attributes
summary: Gets the sub resource for getting the CAM details for this managed attribute
description: Gets the sub resource for getting the CAM details for this managed attribute
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
- in: query
name: uri
required: false
description: The uri query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/roleProfile/managedAttributeDetails/{managedAttributeId}/cam/service':
get:
operationId: ui_CAMResourcesListResource_getServiceResources_8
tags:
- UI CAM
summary: Get the list of CAM resources
description: Get the list of CAM resources
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/roleProfile/managedAttributeDetails/{managedAttributeId}/classifications':
get:
operationId: ui_ClassificationListResource_getClassifications_11
tags:
- Managed Attributes
summary: Public GET method to retrieve a ListResult of ClassificationDTOs
description: Public GET method to retrieve a ListResult of ClassificationDTOs
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/roleProfile/managedAttributeDetails/{managedAttributeId}/inheritance/children':
get:
operationId: ui_ManagedAttributeInheritanceListResource_getChildren_8
tags:
- Managed Attributes
summary: Gets the children managed attributes based on inheritance
description: Gets the children managed attributes based on inheritance
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/roleProfile/managedAttributeDetails/{managedAttributeId}/inheritance/parents':
get:
operationId: ui_ManagedAttributeInheritanceListResource_getParents_8
tags:
- Managed Attributes
summary: Gets the parent managed attributes based on inheritance
description: Gets the parent managed attributes based on inheritance
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/roleProfile/managedAttributeDetails/{managedAttributeId}/members':
get:
operationId: ui_AccountGroupMemberListResource_getMembers_8
tags:
- UI Me
summary: Get the list of account group members
description: Get the list of account group members
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/items/{itemId}/roleProfile/managedAttributeDetails/{managedAttributeId}/roles':
get:
operationId: ui_AccountGroupRolesListResource_getRoles_8
tags:
- UI Approvals
summary: Get the list of associated roles for ManagedAttribute
description: Get the list of associated roles for ManagedAttribute
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/rescind':
post:
operationId: ui_CertificationResource_rescindChildCertification
tags:
- UI Certifications
summary: Rescind a subCertification to the parent
description: Rescind a subCertification to the parent
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/revocations':
get:
operationId: ui_CertificationRevocationListResource_getCertificationRevocations
tags:
- UI Certifications
summary: Get certification revocations
description: Get certification revocations
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/sign':
post:
operationId: ui_CertificationResource_signCertification
tags:
- UI Certifications
summary: Sign certification
description: Sign certification
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"certificationId": "abc-12345", "electronicSignature": {"username": "jsmith", "password": "**hidden**"}}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
object:
type: object
description: The returned object
example: {"object": {"id": "abc-12345", "name": "Example Item"}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/subCertifications':
get:
operationId: ui_CertificationListResource_getSubCertifications
tags:
- UI Certifications
summary: Return certification resource for certification
description: Return certification resource for certification
parameters:
- in: path
name: certificationId
required: true
description: The certificationId.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/suggest/suggest/activityDataSourceTypes':
get:
operationId: ui_SuggestResource_getActivityDataSourceTypesSuggest_12
tags:
- UI Suggest
summary: This endpoint returns List of ActivityDataSourceTypes
description: This endpoint returns List of ActivityDataSourceTypes
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/suggest/suggest/applicationAttributes':
get:
operationId: ui_SuggestResource_getApplicationAttributes_12
tags:
- UI Suggest
summary: Returns data for ApplicationAttributes dropdown in Application Definition screen
description: Returns data for ApplicationAttributes dropdown in Application Definition screen
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appName
required: false
description: The appName query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/suggest/suggest/applications':
get:
operationId: ui_ApplicationSuggestResource_getApplications_12
tags:
- UI Suggest
summary: List of application maps for all applications
description: List of application maps for all applications
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/suggest/suggest/applications/attributeValues':
post:
operationId: ui_ApplicationSuggestResource_getAttributeValues_12
tags:
- UI Suggest
summary: List of values for the given list of application and attribute
description: List of values for the given list of application and attribute
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"applications": "Example Application", "attributes": ["id", "name", "description"], "limit": 25, "query": "name sw \"example\"", "start": 0}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/suggest/suggest/column/{class}/{column}':
get:
operationId: ui_SuggestResource_getColumnSuggestViaHttpGet_12
tags:
- UI Suggest
summary: Returns a list of results for a suggest containing distinct column values on a given class type
description: Returns a list of results for a suggest containing distinct column values on a given class type
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: class
required: true
description: The class.
schema:
type: string
- in: path
name: column
required: true
description: The column.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: ui_SuggestResource_getColumnSuggestViaHttpPost_12
tags:
- UI Suggest
summary: Returns a list of results for a suggest containing distinct column values on a given class type
description: Returns a list of results for a suggest containing distinct column values on a given class type
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: class
required: true
description: The class.
schema:
type: string
- in: path
name: column
required: true
description: The column.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"displayName": "Example Name", "value": "example-value"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/suggest/suggest/identityAttributes':
get:
operationId: ui_SuggestResource_getIdentityAttributes_12
tags:
- UI Suggest
summary: Returns data for IdentityAttributes dropdown in Application Definition Screen
description: Returns data for IdentityAttributes dropdown in Application Definition Screen
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/suggest/suggest/object/{class}':
get:
operationId: ui_SuggestResource_getSuggestViaHttpGet_12
tags:
- UI Suggest
summary: Returns a json data feed for a suggest component for the given class type
description: Returns a json data feed for a suggest component for the given class type
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: class
required: true
description: The class.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: ui_SuggestResource_getSuggestViaHttpPost_12
tags:
- UI Suggest
summary: Returns a json data feed for a suggest component for the given class type
description: Returns a json data feed for a suggest component for the given class type
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: path
name: class
required: true
description: The class.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"displayName": "Example Name", "value": "example-value"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/suggest/suggest/operators':
get:
operationId: ui_SuggestResource_getOperators_12
tags:
- UI Suggest
summary: 'Returns Operators for dropdown in ConditionBasedCorrelation -> Correlation tab'
description: 'Returns Operators for dropdown in ConditionBasedCorrelation -> Correlation tab'
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/suggest/suggest/provisioningActions':
get:
operationId: ui_SuggestResource_getProvisioningActionSuggest_12
tags:
- UI Suggest
summary: This endpoint returns list of provisioning actions in unstructured target page
description: This endpoint returns list of provisioning actions in unstructured target page
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
- in: query
name: targetSourceType
required: false
description: The targetSourceType query parameter.
schema:
type: string
- in: query
name: provisioningOverridden
required: false
description: The provisioningOverridden query parameter.
schema:
type: boolean
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/suggest/suggest/targetSourceTypes':
get:
operationId: ui_SuggestResource_getTargetSourceTypesSuggest_12
tags:
- UI Suggest
summary: This endpoint returns List of TargetSourceTypes corresponding to application type inside unstructured targets tab in the functionality of add/edit application
description: This endpoint returns List of TargetSourceTypes corresponding to application type inside unstructured targets tab in the functionality of add/edit application
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/certifications/{certificationId}/suggest/suggest/targetSources':
get:
operationId: ui_SuggestResource_getTargetSourcesSuggest_12
tags:
- UI Suggest
summary: This endpoint returns List of TargetSources which are relevant for the application corresponding to application type inside unstructured targets tab in the functionality of add/edit application
description: This endpoint returns List of TargetSources which are relevant for the application corresponding to application type inside unstructured targets tab in the functionality of add/edit application
parameters:
- in: path
name: certificationId
required: true
description: The certificationId path parameter.
schema:
type: string
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/comment:
post:
operationId: ui_AccessRequestConfigResource_getCommentConfigs
tags:
- UI Access Request Config
summary: Get the comment configs for the request
description: Get the comment configs for the request
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"type": "ExampleType", "items": "example-items"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"type": "ExampleType", "items": "example-items"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/configuration/AccessHistoryConfiguration:
get:
operationId: ui_AccessHistoryConfigResource_getAccessHistoryConfiguration
tags:
- UI Access History
summary: Gets a map of Attributes from the AccessHistoryConfiguration object
description: Gets a map of Attributes from the AccessHistoryConfiguration object
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"accessHistoryEnabled": true, "sampleString": "example-sampleString", "cfg": {"key": "value"}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
put:
operationId: ui_AccessHistoryConfigResource_putAccessHistoryConfiguration
tags:
- UI Access History
summary: Save a map of Attributes to the AccessHistoryConfiguration object
description: Save a map of Attributes to the AccessHistoryConfiguration object
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"enabled": true, "retentionDays": 90, "includeDetails": true}
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/configuration/DataExtractConfiguration:
get:
operationId: ui_DataExtractConfigResource_getDataExtractConfiguration
tags:
- UI Configuration
summary: Gets a map of Attributes from the DataExtractConfiguration object
description: Gets a map of Attributes from the DataExtractConfiguration object
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"dataExtractTasksEnabled": true, "cfg": {"key": "value"}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
put:
operationId: ui_DataExtractConfigResource_putDataExtractConfiguration
tags:
- UI Configuration
summary: Save a map of Attributes to the DataExtractConfiguration object
description: Save a map of Attributes to the DataExtractConfiguration object
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"enabled": true, "exportFormat": "CSV", "scheduleCron": "0 0 * * *"}
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/configuration/FAMConfiguration:
get:
operationId: ui_FAMConfigResource_getFAMConfiguration
tags:
- UI Configuration
summary: Gets a map of Attributes from the FAMConfiguration object
description: Gets a map of Attributes from the FAMConfiguration object
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"hostname": "Example Host", "authType": "ExampleType", "clientId": "abc-12345", "clientSecret": "example-clientSecret", "userName": "Example User", "password": "**hidden**", "scimCorrelationRule": "example-scimCorrelationRule", "scimCorrelationApplications": ["example-value"], "ruleMap": {"key": "value"}, "appMaps": [{}], "appNames": ["example-value"], "appMap": {"key": "value"}, "ruleName": "Example Rule", "ruleId": "abc-12345", "appId": "abc-12345", "cfg": {"key": "value"}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
put:
operationId: ui_FAMConfigResource_putFAMConfiguration
tags:
- UI Configuration
summary: Save a map of Attributes to the FAMConfiguration object
description: Save a map of Attributes to the FAMConfiguration object
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"host": "fam.example.com", "port": 443, "enabled": true, "token": "example-token"}
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
patch:
operationId: ui_FAMConfigResource_patchFAMConfig
tags:
- UI Configuration
summary: Patch FAMConfiguration from payload
description: Patch FAMConfiguration from payload
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/configuration/FAMConfiguration/suggest/suggest/activityDataSourceTypes:
get:
operationId: ui_SuggestResource_getActivityDataSourceTypesSuggest_13
tags:
- UI Suggest
summary: This endpoint returns List of ActivityDataSourceTypes
description: This endpoint returns List of ActivityDataSourceTypes
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/configuration/FAMConfiguration/suggest/suggest/applicationAttributes:
get:
operationId: ui_SuggestResource_getApplicationAttributes_13
tags:
- UI Suggest
summary: Returns data for ApplicationAttributes dropdown in Application Definition screen
description: Returns data for ApplicationAttributes dropdown in Application Definition screen
parameters:
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appName
required: false
description: The appName query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/configuration/FAMConfiguration/suggest/suggest/applications:
get:
operationId: ui_ApplicationSuggestResource_getApplications_13
tags:
- UI Suggest
summary: List of application maps for all applications
description: List of application maps for all applications
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/configuration/FAMConfiguration/suggest/suggest/applications/attributeValues:
post:
operationId: ui_ApplicationSuggestResource_getAttributeValues_13
tags:
- UI Suggest
summary: List of values for the given list of application and attribute
description: List of values for the given list of application and attribute
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"applications": "Example Application", "attributes": ["id", "name", "description"], "limit": 25, "query": "name sw \"example\"", "start": 0}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/configuration/FAMConfiguration/suggest/suggest/column/{class}/{column}':
get:
operationId: ui_SuggestResource_getColumnSuggestViaHttpGet_13
tags:
- UI Suggest
summary: Returns a list of results for a suggest containing distinct column values on a given class type
description: Returns a list of results for a suggest containing distinct column values on a given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
- in: path
name: column
required: true
description: The column.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: ui_SuggestResource_getColumnSuggestViaHttpPost_13
tags:
- UI Suggest
summary: Returns a list of results for a suggest containing distinct column values on a given class type
description: Returns a list of results for a suggest containing distinct column values on a given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
- in: path
name: column
required: true
description: The column.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"displayName": "Example Name", "value": "example-value"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/configuration/FAMConfiguration/suggest/suggest/identityAttributes:
get:
operationId: ui_SuggestResource_getIdentityAttributes_13
tags:
- UI Suggest
summary: Returns data for IdentityAttributes dropdown in Application Definition Screen
description: Returns data for IdentityAttributes dropdown in Application Definition Screen
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/configuration/FAMConfiguration/suggest/suggest/object/{class}':
get:
operationId: ui_SuggestResource_getSuggestViaHttpGet_13
tags:
- UI Suggest
summary: Returns a json data feed for a suggest component for the given class type
description: Returns a json data feed for a suggest component for the given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: ui_SuggestResource_getSuggestViaHttpPost_13
tags:
- UI Suggest
summary: Returns a json data feed for a suggest component for the given class type
description: Returns a json data feed for a suggest component for the given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"displayName": "Example Name", "value": "example-value"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/configuration/FAMConfiguration/suggest/suggest/operators:
get:
operationId: ui_SuggestResource_getOperators_13
tags:
- UI Suggest
summary: 'Returns Operators for dropdown in ConditionBasedCorrelation -> Correlation tab'
description: 'Returns Operators for dropdown in ConditionBasedCorrelation -> Correlation tab'
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/configuration/FAMConfiguration/suggest/suggest/provisioningActions:
get:
operationId: ui_SuggestResource_getProvisioningActionSuggest_13
tags:
- UI Suggest
summary: This endpoint returns list of provisioning actions in unstructured target page
description: This endpoint returns list of provisioning actions in unstructured target page
parameters:
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
- in: query
name: targetSourceType
required: false
description: The targetSourceType query parameter.
schema:
type: string
- in: query
name: provisioningOverridden
required: false
description: The provisioningOverridden query parameter.
schema:
type: boolean
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/configuration/FAMConfiguration/suggest/suggest/targetSourceTypes:
get:
operationId: ui_SuggestResource_getTargetSourceTypesSuggest_13
tags:
- UI Suggest
summary: This endpoint returns List of TargetSourceTypes corresponding to application type inside unstructured targets tab in the functionality of add/edit application
description: This endpoint returns List of TargetSourceTypes corresponding to application type inside unstructured targets tab in the functionality of add/edit application
parameters:
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/configuration/FAMConfiguration/suggest/suggest/targetSources:
get:
operationId: ui_SuggestResource_getTargetSourcesSuggest_13
tags:
- UI Suggest
summary: This endpoint returns List of TargetSources which are relevant for the application corresponding to application type inside unstructured targets tab in the functionality of add/edit application
description: This endpoint returns List of TargetSources which are relevant for the application corresponding to application type inside unstructured targets tab in the functionality of add/edit application
parameters:
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/configuration/FAMConfiguration/test:
post:
operationId: ui_FAMConfigResource_testConnection
tags:
- UI Configuration
summary: Test connection on a provided map of Attributes
description: Test connection on a provided map of Attributes
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"hostname": "Example Host", "authType": "ExampleType", "clientId": "abc-12345", "clientSecret": "example-clientSecret", "userName": "Example User", "password": "**hidden**", "scimCorrelationRule": "example-scimCorrelationRule", "scimCorrelationApplications": ["example-value"], "ruleMap": {"key": "value"}, "appMaps": [{}], "appNames": ["example-value"], "appMap": {"key": "value"}, "ruleName": "Example Rule", "ruleId": "abc-12345", "appId": "abc-12345", "cfg": {"key": "value"}}
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/configuration/systemconfiguration/teamsAuthWrapperAddress:
get:
operationId: ui_ConfigResource_getTeamsAuthWrapperAddressConfig
tags:
- UI Configuration
summary: This rest call is used to fetch teamsAuthWrapperAddress from SystemConfiguration
description: This rest call is used to fetch teamsAuthWrapperAddress from SystemConfiguration
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: string
example: "example-value"
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/configuration/uiconfig/accessRequest/attachment:
post:
operationId: ui_AccessRequestConfigResource_getAttachmentConfigs_2
tags:
- UI Access Request Config
summary: Get the attachment configs for the request
description: Get the attachment configs for the request
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"type": "ExampleType", "items": "example-items"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"type": "ExampleType", "items": "example-items"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/configuration/uiconfig/accessRequest/comment:
post:
operationId: ui_AccessRequestConfigResource_getCommentConfigs_2
tags:
- UI Access Request Config
summary: Get the comment configs for the request
description: Get the comment configs for the request
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"type": "ExampleType", "items": "example-items"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"type": "ExampleType", "items": "example-items"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/configuration/uiconfig/entries:
get:
operationId: ui_ConfigResource_getUIConfigEntries
tags:
- UI Configuration
summary: Get ui config entries
description: Get ui config entries
parameters:
- in: query
name: key
required: false
description: The key query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"keys": ["UIConfig.certificationTableColumns", "UIConfig.workItemTableColumns"]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/configuration/uiconfig/identity:
get:
operationId: ui_ConfigResource_getIdentityDetailsConfig
tags:
- UI Configuration
summary: Get identity details config
description: Get identity details config
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: array
items:
type: object
example: [{"id": "12345", "name": "Example Item", "description": "Sample record"}]
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/electronicSignature/check:
post:
operationId: ui_ElectronicSignatureResource_checkSignature
tags:
- UI Electronic Signatures
summary: Authentication the signature account/password
description: Authentication the signature account/password
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"signatureId": "abc-12345", "username": "jsmith", "password": "**hidden**"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: SuccessResult
example: {"success": true, "message": "Example message text"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/electronicSignature/esigSamlInfo:
post:
operationId: ui_ElectronicSignatureResource_getEsigSamlInfo
tags:
- UI Electronic Signatures
summary: Return an object containing all the SAML info
description: Return an object containing all the SAML info
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: SAMLInfo
example: {"samlEnabled": true, "identityProvider": "example-provider", "entityId": "https://example.sailpoint.com/saml"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/electronicSignature/forceAuth:
post:
operationId: ui_ElectronicSignatureResource_forceAuth
tags:
- UI Electronic Signatures
summary: This will start the process of SAML signature
description: This will start the process of SAML signature
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"username": "jsmith", "password": "**hidden**"}
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/electronicSignature/samlAuth:
get:
operationId: ui_ElectronicSignatureResource_isSamlAuth
tags:
- UI Electronic Signatures
summary: Check if the configuration supports a SAML signature and if the logged in user is logged in with SAML SSO
description: Check if the configuration supports a SAML signature and if the logged in user is logged in with SAML SSO
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: SAMLStatus
example: {"enabled": true, "provider": "example-provider", "status": "Active"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/forms/createContainer/{app}':
get:
operationId: ui_FormResource_getContainerConfigForm
tags:
- UI Forms
summary: Retrieve a container form from the application by application name
description: Retrieve a container form from the application by application name
parameters:
- in: path
name: app
required: true
description: The app.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: FormDTO
example: {"currentField": "example-currentField", "hideRequiredItemsLegend": true, "labelAlign": "example-labelAlign"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/forms/form/{name}':
get:
operationId: ui_FormResource_getSimpleForm
tags:
- UI Forms
summary: Retrieve a form from the database by name
description: Retrieve a form from the database by name
parameters:
- in: path
name: name
required: true
description: The name.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: FormDTO
example: {"currentField": "example-currentField", "hideRequiredItemsLegend": true, "labelAlign": "example-labelAlign"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/forms/pluginConfig/{id}':
get:
operationId: ui_FormResource_getPluginConfigForm
tags:
- UI Forms
summary: Retrieve a plugin config form from the database by plugin id
description: Retrieve a plugin config form from the database by plugin id
parameters:
- in: path
name: id
required: true
description: The id.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: FormDTO
example: {"currentField": "example-currentField", "hideRequiredItemsLegend": true, "labelAlign": "example-labelAlign"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/forms/workItem/{id}':
get:
operationId: ui_FormResource_getWorkItemForm
tags:
- UI Forms
summary: Returns the form attached to a specific work id (as specified by the id of the work item
description: Returns the form attached to a specific work id (as specified by the id of the work item
parameters:
- in: path
name: id
required: true
description: The id.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: FormDTO
example: {"currentField": "example-currentField", "hideRequiredItemsLegend": true, "labelAlign": "example-labelAlign"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/groupdefinition/{name}':
get:
operationId: ui_GroupDefinitionResource_getGroupDefinition
tags:
- UI Groups
summary: Get a GroupDefinitionDTO for the specified population
description: Get a GroupDefinitionDTO for the specified population
parameters:
- in: path
name: name
required: true
description: The name.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
object:
type: object
description: The returned object
example: {"object": {"id": "abc-12345", "name": "Example Item"}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/identities/widgets/directReports:
get:
operationId: ui_DirectReportsWidgetResource_getDirectReports
tags:
- UI Identities
summary: Return the direct reports information about the users that report to the logged in manager
description: Return the direct reports information about the users that report to the logged in manager
parameters:
- in: query
name: query
required: false
description: The query query parameter.
schema:
type: string
- in: query
name: limit
required: false
description: The limit query parameter.
schema:
type: integer
format: int32
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/identities/workgroups:
get:
operationId: ui_IdentitiesResource_getWorkgroups
tags:
- UI Identities
summary: Get workgroups
description: Get workgroups
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/identities/{identityId}':
get:
operationId: ui_IdentitiesResource_getIdentity
tags:
- UI Identities
summary: 'ex: /ui/rest/identities/{identityId}/summary'
description: 'ex: /ui/rest/identities/{identityId}/summary'
parameters:
- in: path
name: identityId
required: true
description: The identityId.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
object:
type: object
description: The returned object
example: {"object": {"id": "abc-12345", "name": "Example Item"}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/identityOperations:
post:
operationId: ui_IdentityOperationsResource_identityOperations
tags:
- UI Identity Operations
summary: Identity operations
description: Identity operations
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"identityName": "abc-12345", "isIdentityOperation": "abc-12345", "isTerminateIdentity": "abc-12345", "plan": "example-plan", "reasonComments": "Example description"}
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/identityOperations/identities:
get:
operationId: ui_IdentityOperationsIdentityListResource_getRequestableIdentities
tags:
- UI Identity Operations
summary: Returns a list of identities that the current user can request for
description: Returns a list of identities that the current user can request for
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/identityOperations/identities/email:
get:
operationId: ui_IdentityOperationsIdentityListResource_getIdentityEmails
tags:
- UI Identity Operations
summary: Returns a map of identityIds and their corresponding emails for the given identityIds
description: Returns a map of identityIds and their corresponding emails for the given identityIds
parameters:
- in: query
name: identityIds
required: false
description: The identityIds query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"identityIds": ["abc-12345"], "notificationType": "email"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/identityOperations/identities/filters:
get:
operationId: ui_IdentityOperationsIdentityListResource_getIdentityFilters
tags:
- UI Identity Operations
summary: Returns a list of ListFilterDTO objects taken from ObjectConfig that are configured to be searchable on LCM identity searches
description: Returns a list of ListFilterDTO objects taken from ObjectConfig that are configured to be searchable on LCM identity searches
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: array
items:
type: object
example: [{"id": "12345", "name": "Example Item", "description": "Sample record"}]
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/identityOperations/identities/suggest/suggest/activityDataSourceTypes:
get:
operationId: ui_SuggestResource_getActivityDataSourceTypesSuggest_14
tags:
- UI Suggest
summary: This endpoint returns List of ActivityDataSourceTypes
description: This endpoint returns List of ActivityDataSourceTypes
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/identityOperations/identities/suggest/suggest/applicationAttributes:
get:
operationId: ui_SuggestResource_getApplicationAttributes_14
tags:
- UI Suggest
summary: Returns data for ApplicationAttributes dropdown in Application Definition screen
description: Returns data for ApplicationAttributes dropdown in Application Definition screen
parameters:
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appName
required: false
description: The appName query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/identityOperations/identities/suggest/suggest/applications:
get:
operationId: ui_ApplicationSuggestResource_getApplications_14
tags:
- UI Suggest
summary: List of application maps for all applications
description: List of application maps for all applications
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/identityOperations/identities/suggest/suggest/applications/attributeValues:
post:
operationId: ui_ApplicationSuggestResource_getAttributeValues_14
tags:
- UI Suggest
summary: List of values for the given list of application and attribute
description: List of values for the given list of application and attribute
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"applications": "Example Application", "attributes": ["id", "name", "description"], "limit": 25, "query": "name sw \"example\"", "start": 0}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/identityOperations/identities/suggest/suggest/column/{class}/{column}':
get:
operationId: ui_SuggestResource_getColumnSuggestViaHttpGet_14
tags:
- UI Suggest
summary: Returns a list of results for a suggest containing distinct column values on a given class type
description: Returns a list of results for a suggest containing distinct column values on a given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
- in: path
name: column
required: true
description: The column.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: ui_SuggestResource_getColumnSuggestViaHttpPost_14
tags:
- UI Suggest
summary: Returns a list of results for a suggest containing distinct column values on a given class type
description: Returns a list of results for a suggest containing distinct column values on a given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
- in: path
name: column
required: true
description: The column.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"displayName": "Example Name", "value": "example-value"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/identityOperations/identities/suggest/suggest/identityAttributes:
get:
operationId: ui_SuggestResource_getIdentityAttributes_14
tags:
- UI Suggest
summary: Returns data for IdentityAttributes dropdown in Application Definition Screen
description: Returns data for IdentityAttributes dropdown in Application Definition Screen
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/identityOperations/identities/suggest/suggest/object/{class}':
get:
operationId: ui_SuggestResource_getSuggestViaHttpGet_14
tags:
- UI Suggest
summary: Returns a json data feed for a suggest component for the given class type
description: Returns a json data feed for a suggest component for the given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: ui_SuggestResource_getSuggestViaHttpPost_14
tags:
- UI Suggest
summary: Returns a json data feed for a suggest component for the given class type
description: Returns a json data feed for a suggest component for the given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"displayName": "Example Name", "value": "example-value"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/identityOperations/identities/suggest/suggest/operators:
get:
operationId: ui_SuggestResource_getOperators_14
tags:
- UI Suggest
summary: 'Returns Operators for dropdown in ConditionBasedCorrelation -> Correlation tab'
description: 'Returns Operators for dropdown in ConditionBasedCorrelation -> Correlation tab'
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/identityOperations/identities/suggest/suggest/provisioningActions:
get:
operationId: ui_SuggestResource_getProvisioningActionSuggest_14
tags:
- UI Suggest
summary: This endpoint returns list of provisioning actions in unstructured target page
description: This endpoint returns list of provisioning actions in unstructured target page
parameters:
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
- in: query
name: targetSourceType
required: false
description: The targetSourceType query parameter.
schema:
type: string
- in: query
name: provisioningOverridden
required: false
description: The provisioningOverridden query parameter.
schema:
type: boolean
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/identityOperations/identities/suggest/suggest/targetSourceTypes:
get:
operationId: ui_SuggestResource_getTargetSourceTypesSuggest_14
tags:
- UI Suggest
summary: This endpoint returns List of TargetSourceTypes corresponding to application type inside unstructured targets tab in the functionality of add/edit application
description: This endpoint returns List of TargetSourceTypes corresponding to application type inside unstructured targets tab in the functionality of add/edit application
parameters:
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/identityOperations/identities/suggest/suggest/targetSources:
get:
operationId: ui_SuggestResource_getTargetSourcesSuggest_14
tags:
- UI Suggest
summary: This endpoint returns List of TargetSources which are relevant for the application corresponding to application type inside unstructured targets tab in the functionality of add/edit application
description: This endpoint returns List of TargetSources which are relevant for the application corresponding to application type inside unstructured targets tab in the functionality of add/edit application
parameters:
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/identityOperations/identities/{identityId}':
get:
operationId: ui_IdentityOperationsIdentityListResource_getIdentityDetails
tags:
- UI Identity Operations
summary: Returns detail attributes of the specified identity if the current user is authorized to view that identity
description: Returns detail attributes of the specified identity if the current user is authorized to view that identity
parameters:
- in: path
name: identityId
required: true
description: The identityId.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: array
items:
type: object
example: [{"id": "12345", "name": "Example Item", "description": "Sample record"}]
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/identityOperations/identityIdNames:
get:
operationId: ui_IdentityOperationsIdentityIdNameListResource_getRequestableIdentityIdNames
tags:
- UI Identity Operations
summary: 'Returns a list of ids & names of identities that the current user can request for'
description: 'Returns a list of ids & names of identities that the current user can request for'
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/identityOperations/selectedIdentities:
post:
operationId: ui_IdentityOperationsSelectedIdentityListResource_getSelectedIdentities
tags:
- UI Identity Operations
summary: Returns a list of identities requested
description: Returns a list of identities requested
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"start": 0, "limit": 25, "filter": "name sw \"example\""}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/identityPreferences/config:
get:
operationId: ui_IdentityPreferencesResource_getIdentityPreferencesConfig
tags:
- UI Identity Preferences
summary: Return the identity preferences config
description: Return the identity preferences config
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"startDate": "2024-01-01T00:00:00Z", "endDate": "2024-01-01T00:00:00Z", "forwardUser": {}, "startDateTime": 0, "endDateTime": 0, "forwardUserMap": {"key": "value"}, "name": "Example Item", "forwardingUser": {}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/identityPreferences/forwarding:
get:
operationId: ui_IdentityPreferencesResource_getIdentityForwardingPreferences
tags:
- UI Identity Preferences
summary: Return the identity forwarding preferences for the logged in user
description: Return the identity forwarding preferences for the logged in user
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"startDate": "2024-01-01T00:00:00Z", "endDate": "2024-01-01T00:00:00Z", "forwardUser": {}, "startDateTime": 0, "endDateTime": 0, "forwardUserMap": {"key": "value"}, "name": "Example Item", "forwardingUser": {}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
put:
operationId: ui_IdentityPreferencesResource_updateIdentityForwardingPreferences
tags:
- UI Identity Preferences
summary: Return the identity forwarding preferences for the logged in user
description: Return the identity forwarding preferences for the logged in user
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"forwardingEnabled": true, "forwardingUser": "jsmith", "startDate": "2024-01-01T00:00:00Z", "endDate": "2024-12-31T23:59:59Z"}
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/identityPreferences/systemUserAttributes:
get:
operationId: ui_IdentityPreferencesResource_getSystemUserAttributes
tags:
- UI Identity Preferences
summary: Return the system user attributes
description: Return the system user attributes
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"startDate": "2024-01-01T00:00:00Z", "endDate": "2024-01-01T00:00:00Z", "forwardUser": {}, "startDateTime": 0, "endDateTime": 0, "forwardUserMap": {"key": "value"}, "name": "Example Item", "forwardingUser": {}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
put:
operationId: ui_IdentityPreferencesResource_setSystemUserAttributes
tags:
- UI Identity Preferences
summary: Set the system user attributes
description: Set the system user attributes
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"attributeName": "example-attribute", "attributeValue": "example-value"}
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/identityPreferences/updatePassword:
post:
operationId: ui_IdentityPreferencesResource_updatePassword
tags:
- UI Identity Preferences
summary: Update the password for logged in user
description: Update the password for logged in user
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"currentPassword": "**hidden**", "newPassword": "**hidden**", "confirmPassword": "**hidden**"}
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/identityPreferences/userPreferences:
get:
operationId: ui_IdentityPreferencesResource_getUserPreferences
tags:
- UI Identity Preferences
summary: Return the user preferences
description: Return the user preferences
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"startDate": "2024-01-01T00:00:00Z", "endDate": "2024-01-01T00:00:00Z", "forwardUser": {}, "startDateTime": 0, "endDateTime": 0, "forwardUserMap": {"key": "value"}, "name": "Example Item", "forwardingUser": {}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
put:
operationId: ui_IdentityPreferencesResource_setUserPreferences
tags:
- UI Identity Preferences
summary: Set the user preferences
description: Set the user preferences
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"preferenceKey": "example-preference", "preferenceValue": "example-value"}
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/identityRequests:
get:
operationId: ui_IdentityRequestListResource_getIdentityRequests
tags:
- UI Identity Requests
summary: Get the list of identity requests for the logged in user
description: Get the list of identity requests for the logged in user
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/identityRequests/filters:
get:
operationId: ui_IdentityRequestListResource_getIdentityRequestFilters
tags:
- UI Identity Requests
summary: Get the list of filters for the identity requests list page
description: Get the list of filters for the identity requests list page
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: array
items:
type: object
example: [{"id": "12345", "name": "Example Item", "description": "Sample record"}]
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/identityRequests/suggest/suggest/activityDataSourceTypes:
get:
operationId: ui_SuggestResource_getActivityDataSourceTypesSuggest_15
tags:
- UI Suggest
summary: This endpoint returns List of ActivityDataSourceTypes
description: This endpoint returns List of ActivityDataSourceTypes
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/identityRequests/suggest/suggest/applicationAttributes:
get:
operationId: ui_SuggestResource_getApplicationAttributes_15
tags:
- UI Suggest
summary: Returns data for ApplicationAttributes dropdown in Application Definition screen
description: Returns data for ApplicationAttributes dropdown in Application Definition screen
parameters:
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appName
required: false
description: The appName query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/identityRequests/suggest/suggest/applications:
get:
operationId: ui_ApplicationSuggestResource_getApplications_15
tags:
- UI Suggest
summary: List of application maps for all applications
description: List of application maps for all applications
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/identityRequests/suggest/suggest/applications/attributeValues:
post:
operationId: ui_ApplicationSuggestResource_getAttributeValues_15
tags:
- UI Suggest
summary: List of values for the given list of application and attribute
description: List of values for the given list of application and attribute
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"applications": "Example Application", "attributes": ["id", "name", "description"], "limit": 25, "query": "name sw \"example\"", "start": 0}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/identityRequests/suggest/suggest/column/{class}/{column}':
get:
operationId: ui_SuggestResource_getColumnSuggestViaHttpGet_15
tags:
- UI Suggest
summary: Returns a list of results for a suggest containing distinct column values on a given class type
description: Returns a list of results for a suggest containing distinct column values on a given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
- in: path
name: column
required: true
description: The column.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: ui_SuggestResource_getColumnSuggestViaHttpPost_15
tags:
- UI Suggest
summary: Returns a list of results for a suggest containing distinct column values on a given class type
description: Returns a list of results for a suggest containing distinct column values on a given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
- in: path
name: column
required: true
description: The column.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"displayName": "Example Name", "value": "example-value"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/identityRequests/suggest/suggest/identityAttributes:
get:
operationId: ui_SuggestResource_getIdentityAttributes_15
tags:
- UI Suggest
summary: Returns data for IdentityAttributes dropdown in Application Definition Screen
description: Returns data for IdentityAttributes dropdown in Application Definition Screen
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/identityRequests/suggest/suggest/object/{class}':
get:
operationId: ui_SuggestResource_getSuggestViaHttpGet_15
tags:
- UI Suggest
summary: Returns a json data feed for a suggest component for the given class type
description: Returns a json data feed for a suggest component for the given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: ui_SuggestResource_getSuggestViaHttpPost_15
tags:
- UI Suggest
summary: Returns a json data feed for a suggest component for the given class type
description: Returns a json data feed for a suggest component for the given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"displayName": "Example Name", "value": "example-value"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/identityRequests/suggest/suggest/operators:
get:
operationId: ui_SuggestResource_getOperators_15
tags:
- UI Suggest
summary: 'Returns Operators for dropdown in ConditionBasedCorrelation -> Correlation tab'
description: 'Returns Operators for dropdown in ConditionBasedCorrelation -> Correlation tab'
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/identityRequests/suggest/suggest/provisioningActions:
get:
operationId: ui_SuggestResource_getProvisioningActionSuggest_15
tags:
- UI Suggest
summary: This endpoint returns list of provisioning actions in unstructured target page
description: This endpoint returns list of provisioning actions in unstructured target page
parameters:
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
- in: query
name: targetSourceType
required: false
description: The targetSourceType query parameter.
schema:
type: string
- in: query
name: provisioningOverridden
required: false
description: The provisioningOverridden query parameter.
schema:
type: boolean
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/identityRequests/suggest/suggest/targetSourceTypes:
get:
operationId: ui_SuggestResource_getTargetSourceTypesSuggest_15
tags:
- UI Suggest
summary: This endpoint returns List of TargetSourceTypes corresponding to application type inside unstructured targets tab in the functionality of add/edit application
description: This endpoint returns List of TargetSourceTypes corresponding to application type inside unstructured targets tab in the functionality of add/edit application
parameters:
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/identityRequests/suggest/suggest/targetSources:
get:
operationId: ui_SuggestResource_getTargetSourcesSuggest_15
tags:
- UI Suggest
summary: This endpoint returns List of TargetSources which are relevant for the application corresponding to application type inside unstructured targets tab in the functionality of add/edit application
description: This endpoint returns List of TargetSources which are relevant for the application corresponding to application type inside unstructured targets tab in the functionality of add/edit application
parameters:
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/identityRequests/{requestId}':
get:
operationId: ui_IdentityRequestResource_getIdentityRequest
tags:
- UI Identity Requests
summary: Get a IdentityRequestDTO representation of the identity request
description: Get a IdentityRequestDTO representation of the identity request
parameters:
- in: path
name: requestId
required: true
description: The requestId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: IdentityRequestDTO
example: {"policyName": "Example Policy", "policyType": "ExampleType", "ruleName": "Example Rule", "type": "ExampleType", "targetDisplayName": "Example Targetdisplay", "requesterDisplayName": "Example Requesterdisplay", "requestId": "abc-12345", "priority": "example-priority", "createdDate": "2024-01-01T00:00:00Z", "endDate": "2024-01-01T00:00:00Z", "terminatedDate": "2024-01-01T00:00:00Z", "items": [{"workItemId": "abc-12345", "approvalItemId": "abc-12345", "owner": {}, "commentCount": 1, "created": "2024-01-01T00:00:00Z", "canAccessComments": true, "messageKey": "example-messageKey", "operation": {}, "applicationName": "Example Application", "role": true, "entitlement": true, "hasManagedAttribute": true, "accountName": "Example Account", "name": "Example Item", "value": "example-value", "displayableValue": "example-displayableValue", "approvalItemSummaries": [{}], "displayableAccountName": "Example Displayableaccount", "startDate": "2024-01-01T00:00:00Z", "endDate": "2024-01-01T00:00:00Z", "requesterComments": "example-requesterComments", "provisioningEngine": "example-provisioningEngine", "retries": 0, "provisioningRequestId": "abc-12345", "assignmentId": "abc-12345", "canViewAttachments": true, "attachmentConfigList": [{}], "attachments": [{}], "classificationNames": ["example-value"], "attributes": {"key": "value"}}], "id": "abc-12345", "externalTicketId": "abc-12345", "cancelable": true, "state": "Active", "verificationDate": "2024-01-01T00:00:00Z", "policyViolations": [{"messageKey": "example-messageKey", "renderer": "example-renderer", "identity": {}, "policyId": "abc-12345", "policyName": "Example Policy", "constraintId": "abc-12345", "constraintName": "Example Constraint", "leftBundles": "example-leftBundles", "rightBundles": "example-rightBundles", "bundlesMarkedForRemediation": "example-bundlesMarkedForRemediation", "entitlementsMarkedForRemediation": "example-entitlementsMarkedForRemediation", "mitigator": "example-mitigator", "activityId": "abc-12345", "arguments": {"key": "value"}, "status": {}, "names": ["example-value"], "p": {}, "name": "Example Item", "b": {}, "bundles": [{}], "bundleNames": ["example-value"], "id": "abc-12345", "cols": {"key": "value"}, "apps": [{}], "appNames": ["example-value"], "json": "example-json", "entitlements": ["example-value"], "csv": "example-csv", "resposne": "example-resposne", "itemList": ["example-value"], "values": ["example-value"], "application": "Example Application"}], "interactions": [{"workItemId": "abc-12345", "ownerDisplayName": "Example Ownerdisplay", "comments": [{}], "openDate": "2024-01-01T00:00:00Z", "completeDate": "2024-01-01T00:00:00Z", "status": "Active", "approvalItemCount": 1, "description": "A brief description.", "workItemArchiveId": "abc-12345", "hasWorkItemAccess": true, "workItemName": "Example Workitem"}], "policyViolationMaps": [{}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/identityRequests/{requestId}/cancel':
post:
operationId: ui_IdentityRequestResource_cancelRequest
tags:
- UI Identity Requests
summary: Cancel the workflow associated with this identity request
description: Cancel the workflow associated with this identity request
parameters:
- in: path
name: requestId
required: true
description: The requestId path parameter.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"requestId": "abc-12345", "reason": "Request no longer needed"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Request status
requestID:
type: string
description: Request identifier
errors:
type: array
description: Errors
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
example: {"status": "success", "requestID": "abc-123", "errors": [], "warnings": []}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/identityRequests/{requestId}/changeItems':
get:
operationId: ui_IdentityRequestChangeItemListResource_getChangeItems
tags:
- UI Identity Requests
summary: Get a ListResult containing provisioning IdentityRequestItemDTOs for the given request
description: Get a ListResult containing provisioning IdentityRequestItemDTOs for the given request
parameters:
- in: path
name: requestId
required: true
description: The requestId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/identityRequests/{requestId}/email/{workItemId}/reminder':
get:
operationId: ui_BaseEmailResource_getTemplate_2
tags:
- UI Certifications
summary: Fetches an EmailTemplateDTO that can be modified before sending
description: Fetches an EmailTemplateDTO that can be modified before sending
parameters:
- in: path
name: requestId
required: true
description: The requestId path parameter.
schema:
type: string
- in: path
name: workItemId
required: true
description: The workItemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: EmailTemplateDTO
example: {"to": "example-to", "from": "example-from", "subject": "example-subject", "body": "example-body", "comment": "example-comment", "cc": "example-cc", "bcc": "example-bcc", "toIdentity": {}, "sessionProperties": {"key": "value"}, "toIdentityReadOnly": true, "email": "user@example.com", "workgroup": true}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/identityRequests/{requestId}/email/{workItemId}/reminder/send':
post:
operationId: ui_BaseEmailResource_sendEmail_2
tags:
- UI Certifications
summary: Sends the provided template out through the email service
description: Sends the provided template out through the email service
parameters:
- in: path
name: requestId
required: true
description: The requestId path parameter.
schema:
type: string
- in: path
name: workItemId
required: true
description: The workItemId path parameter.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"to": "example-to", "from": "example-from", "subject": "example-subject", "body": "example-body", "comment": "example-comment", "cc": "example-cc", "bcc": "example-bcc", "toIdentity": {}, "sessionProperties": {"key": "value"}, "toIdentityReadOnly": true, "email": "user@example.com", "workgroup": true}
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/identityRequests/{requestId}/interactions':
get:
operationId: ui_IdentityRequestResource_getInteractions
tags:
- UI Identity Requests
summary: Get the list of interactions for the identity request
description: Get the list of interactions for the identity request
parameters:
- in: path
name: requestId
required: true
description: The requestId path parameter.
schema:
type: string
- in: query
name: sort
required: false
description: The sort query parameter.
schema:
type: string
- in: query
name: start
required: false
description: The start query parameter.
schema:
type: string
- in: query
name: limit
required: false
description: The limit query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/identityRequests/{requestId}/items':
get:
operationId: ui_IdentityRequestItemListResource_getItems
tags:
- UI Identity Requests
summary: Get a ListResult containing IdentityRequestItemDTOs for the given request
description: Get a ListResult containing IdentityRequestItemDTOs for the given request
parameters:
- in: path
name: requestId
required: true
description: The requestId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/identityRequests/{requestId}/items/{itemId}/managedAttributeDetails':
get:
operationId: ui_ManagedAttributeDetailResource_getDetails_10
tags:
- Managed Attributes
summary: Get the details for the managed attribute
description: Get the details for the managed attribute
parameters:
- in: path
name: requestId
required: true
description: The requestId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: ManagedAttributeDetailDTO
example: {"id": "abc-12345", "application": "Example Application", "type": "ExampleType", "attribute": "example-attribute", "value": "example-value", "displayValue": "example-displayValue", "description": "A brief description.", "owner": "jsmith", "requestable": true, "iiqElevatedAccess": true, "extendedAttributes": {"key": "value"}, "groupAttributes": {"key": "value"}, "groupEntitlements": [{"nativeIdentity": "example-nativeIdentity", "accountName": "Example Account", "assigned": true, "grantedByRole": true, "startDate": "2024-01-01T00:00:00Z", "endDate": "2024-01-01T00:00:00Z", "lastCertDate": "2024-01-01T00:00:00Z", "lastCertName": "Example Lastcert", "lastCertificationItem": {}, "pendingCertificationItem": {}, "lastRequestItem": {}, "pendingRequestItem": {}, "assigner": "example-assigner", "source": "example-source", "foundOnAccount": true, "detectedRole": true, "hasPendingRequest": true, "pendingRequestId": "abc-12345", "allowed": true, "entitlementRequireEndDateTime": true, "entitlementMaxAccessTimeEnabled": true, "entitlementMaxAccessTimeValue": 0, "entitlementMaxAccessTimeUnit": "example-entitlementMaxAccessTimeUnit", "sourceAssignableRoleNames": ["example-value"], "sourceDetectableRoleNames": ["example-value"], "lastItem": {}, "pendingItem": {}}], "hasInheritance": true, "hasAccess": true, "hasMembers": true, "hasClassifications": true, "hasCloudAccess": true, "hasRoles": true}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/identityRequests/{requestId}/items/{itemId}/managedAttributeDetails/access':
get:
operationId: ui_TargetAssociationListResource_getAssociations_9
tags:
- Managed Attributes
summary: Get associations
description: Get associations
parameters:
- in: path
name: requestId
required: true
description: The requestId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/identityRequests/{requestId}/items/{itemId}/managedAttributeDetails/cam/group':
get:
operationId: ui_ManagedAttributeDetailResource_getGroup_10
tags:
- Managed Attributes
summary: Gets the sub resource for getting the CAM group details for this managed attribute
description: Gets the sub resource for getting the CAM group details for this managed attribute
parameters:
- in: path
name: requestId
required: true
description: The requestId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: CAMGroupDTO
example: {"errors": ["example-value"], "roles": [{"nativeId": "abc-12345", "cspType": "ExampleType", "displayName": "Example Display", "uri": "https://example.sailpoint.com", "adminCount": 1, "writeCount": 1, "readCount": 1, "scopes": [{}], "errors": ["example-value"], "camScopeDTO": {}}], "services": [{"name": "Example Item", "type": "ExampleType", "numResources": 0}], "uri": "https://example.sailpoint.com", "cspType": "ExampleType", "nativeId": "abc-12345", "displayName": "Example Display", "rolesList": {"items": [{}], "federatedRolesList": {}, "sb": {}}, "servicesList": {"items": [{}], "servicesList": {}, "sb": {}}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/identityRequests/{requestId}/items/{itemId}/managedAttributeDetails/cam/scope':
get:
operationId: ui_ManagedAttributeDetailResource_getScopeServices_10
tags:
- Managed Attributes
summary: Gets the sub resource for getting the CAM details for this managed attribute
description: Gets the sub resource for getting the CAM details for this managed attribute
parameters:
- in: path
name: requestId
required: true
description: The requestId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: query
name: uri
required: false
description: The uri query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/identityRequests/{requestId}/items/{itemId}/managedAttributeDetails/cam/service':
get:
operationId: ui_CAMResourcesListResource_getServiceResources_9
tags:
- UI CAM
summary: Get the list of CAM resources
description: Get the list of CAM resources
parameters:
- in: path
name: requestId
required: true
description: The requestId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/identityRequests/{requestId}/items/{itemId}/managedAttributeDetails/classifications':
get:
operationId: ui_ClassificationListResource_getClassifications_12
tags:
- Managed Attributes
summary: Public GET method to retrieve a ListResult of ClassificationDTOs
description: Public GET method to retrieve a ListResult of ClassificationDTOs
parameters:
- in: path
name: requestId
required: true
description: The requestId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/identityRequests/{requestId}/items/{itemId}/managedAttributeDetails/inheritance/children':
get:
operationId: ui_ManagedAttributeInheritanceListResource_getChildren_9
tags:
- Managed Attributes
summary: Gets the children managed attributes based on inheritance
description: Gets the children managed attributes based on inheritance
parameters:
- in: path
name: requestId
required: true
description: The requestId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/identityRequests/{requestId}/items/{itemId}/managedAttributeDetails/inheritance/parents':
get:
operationId: ui_ManagedAttributeInheritanceListResource_getParents_9
tags:
- Managed Attributes
summary: Gets the parent managed attributes based on inheritance
description: Gets the parent managed attributes based on inheritance
parameters:
- in: path
name: requestId
required: true
description: The requestId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/identityRequests/{requestId}/items/{itemId}/managedAttributeDetails/members':
get:
operationId: ui_AccountGroupMemberListResource_getMembers_9
tags:
- UI Me
summary: Get the list of account group members
description: Get the list of account group members
parameters:
- in: path
name: requestId
required: true
description: The requestId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/identityRequests/{requestId}/items/{itemId}/managedAttributeDetails/roles':
get:
operationId: ui_AccountGroupRolesListResource_getRoles_9
tags:
- UI Approvals
summary: Get the list of associated roles for ManagedAttribute
description: Get the list of associated roles for ManagedAttribute
parameters:
- in: path
name: requestId
required: true
description: The requestId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/identityRequests/{requestId}/items/{itemId}/roleDetails':
get:
operationId: ui_RoleDetailResource_getDetails_5
tags:
- Roles
summary: Get a RoleDetailDTO to represent to current role
description: Get a RoleDetailDTO to represent to current role
parameters:
- in: path
name: requestId
required: true
description: The requestId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: RoleDetailDTO
example: {"id": "abc-12345", "identityId": "abc-12345", "identityDisplayName": "Example Identitydisplay", "assignmentId": "abc-12345", "identityHasRole": true, "assigned": true, "detected": true, "displayName": "Example Display", "type": "ExampleType", "typeIcon": "example-typeIcon", "owner": {"id": "abc-12345", "name": "Example Item", "displayName": "Example Display"}, "description": "A brief description.", "iiqElevatedAccess": true, "permittedBy": "example-permittedBy", "assignmentNote": "example-assignmentNote", "accountDetails": [{"value": "example-value", "application": "Example Application", "account": 1, "nativeIdentity": "example-nativeIdentity", "sourceRole": "example-sourceRole", "iiqElevatedAccess": true}], "contributingEntitlements": [{"nativeIdentity": "example-nativeIdentity", "accountName": "Example Account", "assigned": true, "grantedByRole": true, "startDate": "2024-01-01T00:00:00Z", "endDate": "2024-01-01T00:00:00Z", "lastCertDate": "2024-01-01T00:00:00Z", "lastCertName": "Example Lastcert", "lastCertificationItem": {}, "pendingCertificationItem": {}, "lastRequestItem": {}, "pendingRequestItem": {}, "assigner": "example-assigner", "source": "example-source", "foundOnAccount": true, "detectedRole": true, "hasPendingRequest": true, "pendingRequestId": "abc-12345", "allowed": true, "entitlementRequireEndDateTime": true, "entitlementMaxAccessTimeEnabled": true, "entitlementMaxAccessTimeValue": 0, "entitlementMaxAccessTimeUnit": "example-entitlementMaxAccessTimeUnit", "sourceAssignableRoleNames": ["example-value"], "sourceDetectableRoleNames": ["example-value"], "lastItem": {}, "pendingItem": {}}], "permittedRoles": [{}], "requiredRoles": [{}], "hierarchy": [{}], "hasHierarchy": true, "classificationNames": ["example-value"], "profiles": [{"name": "Example Item", "application": "Example Application", "iiqElevatedAccess": true, "constraints": ["example-value"], "permissions": [{}], "entitlements": [{}]}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/identityRequests/{requestId}/items/{itemId}/roleDetails/classifications':
get:
operationId: ui_ClassificationListResource_getClassifications_13
tags:
- Managed Attributes
summary: Public GET method to retrieve a ListResult of ClassificationDTOs
description: Public GET method to retrieve a ListResult of ClassificationDTOs
parameters:
- in: path
name: requestId
required: true
description: The requestId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/identityRequests/{requestId}/items/{itemId}/roleDetails/simpleEntitlements':
get:
operationId: ui_RoleDetailResource_getSimpleEntitlements_5
tags:
- Roles
summary: Returns a list of simple entitlements on the specified role
description: Returns a list of simple entitlements on the specified role
parameters:
- in: path
name: requestId
required: true
description: The requestId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/identityRequests/{requestId}/items/{itemId}/roleDetails/{managedAttributeId}/managedAttributeDetails':
get:
operationId: ui_ManagedAttributeDetailResource_getDetails_11
tags:
- Managed Attributes
summary: Get the details for the managed attribute
description: Get the details for the managed attribute
parameters:
- in: path
name: requestId
required: true
description: The requestId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: ManagedAttributeDetailDTO
example: {"id": "abc-12345", "application": "Example Application", "type": "ExampleType", "attribute": "example-attribute", "value": "example-value", "displayValue": "example-displayValue", "description": "A brief description.", "owner": "jsmith", "requestable": true, "iiqElevatedAccess": true, "extendedAttributes": {"key": "value"}, "groupAttributes": {"key": "value"}, "groupEntitlements": [{"nativeIdentity": "example-nativeIdentity", "accountName": "Example Account", "assigned": true, "grantedByRole": true, "startDate": "2024-01-01T00:00:00Z", "endDate": "2024-01-01T00:00:00Z", "lastCertDate": "2024-01-01T00:00:00Z", "lastCertName": "Example Lastcert", "lastCertificationItem": {}, "pendingCertificationItem": {}, "lastRequestItem": {}, "pendingRequestItem": {}, "assigner": "example-assigner", "source": "example-source", "foundOnAccount": true, "detectedRole": true, "hasPendingRequest": true, "pendingRequestId": "abc-12345", "allowed": true, "entitlementRequireEndDateTime": true, "entitlementMaxAccessTimeEnabled": true, "entitlementMaxAccessTimeValue": 0, "entitlementMaxAccessTimeUnit": "example-entitlementMaxAccessTimeUnit", "sourceAssignableRoleNames": ["example-value"], "sourceDetectableRoleNames": ["example-value"], "lastItem": {}, "pendingItem": {}}], "hasInheritance": true, "hasAccess": true, "hasMembers": true, "hasClassifications": true, "hasCloudAccess": true, "hasRoles": true}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/identityRequests/{requestId}/items/{itemId}/roleDetails/{managedAttributeId}/managedAttributeDetails/access':
get:
operationId: ui_TargetAssociationListResource_getAssociations_10
tags:
- Managed Attributes
summary: Get associations
description: Get associations
parameters:
- in: path
name: requestId
required: true
description: The requestId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/identityRequests/{requestId}/items/{itemId}/roleDetails/{managedAttributeId}/managedAttributeDetails/cam/group':
get:
operationId: ui_ManagedAttributeDetailResource_getGroup_11
tags:
- Managed Attributes
summary: Gets the sub resource for getting the CAM group details for this managed attribute
description: Gets the sub resource for getting the CAM group details for this managed attribute
parameters:
- in: path
name: requestId
required: true
description: The requestId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: CAMGroupDTO
example: {"errors": ["example-value"], "roles": [{"nativeId": "abc-12345", "cspType": "ExampleType", "displayName": "Example Display", "uri": "https://example.sailpoint.com", "adminCount": 1, "writeCount": 1, "readCount": 1, "scopes": [{}], "errors": ["example-value"], "camScopeDTO": {}}], "services": [{"name": "Example Item", "type": "ExampleType", "numResources": 0}], "uri": "https://example.sailpoint.com", "cspType": "ExampleType", "nativeId": "abc-12345", "displayName": "Example Display", "rolesList": {"items": [{}], "federatedRolesList": {}, "sb": {}}, "servicesList": {"items": [{}], "servicesList": {}, "sb": {}}}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/identityRequests/{requestId}/items/{itemId}/roleDetails/{managedAttributeId}/managedAttributeDetails/cam/scope':
get:
operationId: ui_ManagedAttributeDetailResource_getScopeServices_11
tags:
- Managed Attributes
summary: Gets the sub resource for getting the CAM details for this managed attribute
description: Gets the sub resource for getting the CAM details for this managed attribute
parameters:
- in: path
name: requestId
required: true
description: The requestId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
- in: query
name: uri
required: false
description: The uri query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/identityRequests/{requestId}/items/{itemId}/roleDetails/{managedAttributeId}/managedAttributeDetails/cam/service':
get:
operationId: ui_CAMResourcesListResource_getServiceResources_10
tags:
- UI CAM
summary: Get the list of CAM resources
description: Get the list of CAM resources
parameters:
- in: path
name: requestId
required: true
description: The requestId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/identityRequests/{requestId}/items/{itemId}/roleDetails/{managedAttributeId}/managedAttributeDetails/classifications':
get:
operationId: ui_ClassificationListResource_getClassifications_14
tags:
- Managed Attributes
summary: Public GET method to retrieve a ListResult of ClassificationDTOs
description: Public GET method to retrieve a ListResult of ClassificationDTOs
parameters:
- in: path
name: requestId
required: true
description: The requestId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/identityRequests/{requestId}/items/{itemId}/roleDetails/{managedAttributeId}/managedAttributeDetails/inheritance/children':
get:
operationId: ui_ManagedAttributeInheritanceListResource_getChildren_10
tags:
- Managed Attributes
summary: Gets the children managed attributes based on inheritance
description: Gets the children managed attributes based on inheritance
parameters:
- in: path
name: requestId
required: true
description: The requestId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/identityRequests/{requestId}/items/{itemId}/roleDetails/{managedAttributeId}/managedAttributeDetails/inheritance/parents':
get:
operationId: ui_ManagedAttributeInheritanceListResource_getParents_10
tags:
- Managed Attributes
summary: Gets the parent managed attributes based on inheritance
description: Gets the parent managed attributes based on inheritance
parameters:
- in: path
name: requestId
required: true
description: The requestId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/identityRequests/{requestId}/items/{itemId}/roleDetails/{managedAttributeId}/managedAttributeDetails/members':
get:
operationId: ui_AccountGroupMemberListResource_getMembers_10
tags:
- UI Me
summary: Get the list of account group members
description: Get the list of account group members
parameters:
- in: path
name: requestId
required: true
description: The requestId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/identityRequests/{requestId}/items/{itemId}/roleDetails/{managedAttributeId}/managedAttributeDetails/roles':
get:
operationId: ui_AccountGroupRolesListResource_getRoles_10
tags:
- UI Approvals
summary: Get the list of associated roles for ManagedAttribute
description: Get the list of associated roles for ManagedAttribute
parameters:
- in: path
name: requestId
required: true
description: The requestId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: managedAttributeId
required: true
description: The managedAttributeId path parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/identityRequests/{requestId}/items/{itemId}/roleDetails/{subRoleId}/hierarchy':
get:
operationId: ui_RoleDetailResource_getHierarchy_5
tags:
- Roles
summary: Get a list of RoleDetailDTOs to represent the next level of hierarchy for the given sub role
description: Get a list of RoleDetailDTOs to represent the next level of hierarchy for the given sub role
parameters:
- in: path
name: requestId
required: true
description: The requestId path parameter.
schema:
type: string
- in: path
name: itemId
required: true
description: The itemId path parameter.
schema:
type: string
- in: path
name: subRoleId
required: true
description: The subRoleId.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: array
items:
type: object
example: [{"id": "12345", "name": "Example Item", "description": "Sample record"}]
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/identityRequests/{requestId}/messages':
get:
operationId: ui_IdentityRequestResource_getMessages
tags:
- UI Identity Requests
summary: 'Get the error, warning and info type messages'
description: 'Get the error, warning and info type messages'
parameters:
- in: path
name: requestId
required: true
description: The requestId path parameter.
schema:
type: string
- in: query
name: sort
required: false
description: The sort query parameter.
schema:
type: string
- in: query
name: start
required: false
description: The start query parameter.
schema:
type: string
- in: query
name: limit
required: false
description: The limit query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/identityTriggers/durations:
get:
operationId: ui_IdentityTriggerResource_getDurations
tags:
- UI Identity Triggers
summary: Get durations
description: Get durations
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: array
items:
type: object
example: [{"id": "12345", "name": "Example Item", "description": "Sample record"}]
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/identityTriggers/identityAttributeFilters:
get:
operationId: ui_IdentityTriggerResource_getIdentityAttributeFilters
tags:
- UI Identity Triggers
summary: Gets a list of Identity attributes (as filters)
description: Gets a list of Identity attributes (as filters)
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: array
items:
type: object
example: [{"id": "12345", "name": "Example Item", "description": "Sample record"}]
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/identityTriggers/identityAttributeFiltersSuggest/suggest/activityDataSourceTypes:
get:
operationId: ui_SuggestResource_getActivityDataSourceTypesSuggest_16
tags:
- UI Suggest
summary: This endpoint returns List of ActivityDataSourceTypes
description: This endpoint returns List of ActivityDataSourceTypes
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/identityTriggers/identityAttributeFiltersSuggest/suggest/applicationAttributes:
get:
operationId: ui_SuggestResource_getApplicationAttributes_16
tags:
- UI Suggest
summary: Returns data for ApplicationAttributes dropdown in Application Definition screen
description: Returns data for ApplicationAttributes dropdown in Application Definition screen
parameters:
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appName
required: false
description: The appName query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/identityTriggers/identityAttributeFiltersSuggest/suggest/applications:
get:
operationId: ui_ApplicationSuggestResource_getApplications_16
tags:
- UI Suggest
summary: List of application maps for all applications
description: List of application maps for all applications
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/identityTriggers/identityAttributeFiltersSuggest/suggest/applications/attributeValues:
post:
operationId: ui_ApplicationSuggestResource_getAttributeValues_16
tags:
- UI Suggest
summary: List of values for the given list of application and attribute
description: List of values for the given list of application and attribute
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"applications": "Example Application", "attributes": ["id", "name", "description"], "limit": 25, "query": "name sw \"example\"", "start": 0}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/identityTriggers/identityAttributeFiltersSuggest/suggest/column/{class}/{column}':
get:
operationId: ui_SuggestResource_getColumnSuggestViaHttpGet_16
tags:
- UI Suggest
summary: Returns a list of results for a suggest containing distinct column values on a given class type
description: Returns a list of results for a suggest containing distinct column values on a given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
- in: path
name: column
required: true
description: The column.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: ui_SuggestResource_getColumnSuggestViaHttpPost_16
tags:
- UI Suggest
summary: Returns a list of results for a suggest containing distinct column values on a given class type
description: Returns a list of results for a suggest containing distinct column values on a given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
- in: path
name: column
required: true
description: The column.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"displayName": "Example Name", "value": "example-value"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/identityTriggers/identityAttributeFiltersSuggest/suggest/identityAttributes:
get:
operationId: ui_SuggestResource_getIdentityAttributes_16
tags:
- UI Suggest
summary: Returns data for IdentityAttributes dropdown in Application Definition Screen
description: Returns data for IdentityAttributes dropdown in Application Definition Screen
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/identityTriggers/identityAttributeFiltersSuggest/suggest/object/{class}':
get:
operationId: ui_SuggestResource_getSuggestViaHttpGet_16
tags:
- UI Suggest
summary: Returns a json data feed for a suggest component for the given class type
description: Returns a json data feed for a suggest component for the given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
post:
operationId: ui_SuggestResource_getSuggestViaHttpPost_16
tags:
- UI Suggest
summary: Returns a json data feed for a suggest component for the given class type
description: Returns a json data feed for a suggest component for the given class type
parameters:
- in: path
name: class
required: true
description: The class.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"displayName": "Example Name", "value": "example-value"}
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/identityTriggers/identityAttributeFiltersSuggest/suggest/operators:
get:
operationId: ui_SuggestResource_getOperators_16
tags:
- UI Suggest
summary: 'Returns Operators for dropdown in ConditionBasedCorrelation -> Correlation tab'
description: 'Returns Operators for dropdown in ConditionBasedCorrelation -> Correlation tab'
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/identityTriggers/identityAttributeFiltersSuggest/suggest/provisioningActions:
get:
operationId: ui_SuggestResource_getProvisioningActionSuggest_16
tags:
- UI Suggest
summary: This endpoint returns list of provisioning actions in unstructured target page
description: This endpoint returns list of provisioning actions in unstructured target page
parameters:
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
- in: query
name: targetSourceType
required: false
description: The targetSourceType query parameter.
schema:
type: string
- in: query
name: provisioningOverridden
required: false
description: The provisioningOverridden query parameter.
schema:
type: boolean
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/identityTriggers/identityAttributeFiltersSuggest/suggest/targetSourceTypes:
get:
operationId: ui_SuggestResource_getTargetSourceTypesSuggest_16
tags:
- UI Suggest
summary: This endpoint returns List of TargetSourceTypes corresponding to application type inside unstructured targets tab in the functionality of add/edit application
description: This endpoint returns List of TargetSourceTypes corresponding to application type inside unstructured targets tab in the functionality of add/edit application
parameters:
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/identityTriggers/identityAttributeFiltersSuggest/suggest/targetSources:
get:
operationId: ui_SuggestResource_getTargetSourcesSuggest_16
tags:
- UI Suggest
summary: This endpoint returns List of TargetSources which are relevant for the application corresponding to application type inside unstructured targets tab in the functionality of add/edit application
description: This endpoint returns List of TargetSources which are relevant for the application corresponding to application type inside unstructured targets tab in the functionality of add/edit application
parameters:
- in: query
name: appId
required: false
description: The appId query parameter.
schema:
type: string
- in: query
name: appType
required: false
description: The appType query parameter.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Total number of results
objects:
type: array
description: Result list
items:
type: object
example: {"count": 1, "objects": [{"id": "abc-12345", "name": "Example Item"}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/identityTriggers/operations:
get:
operationId: ui_IdentityTriggerResource_getOperationsByDataType
tags:
- UI Identity Triggers
summary: Get operations by data type
description: Get operations by data type
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"dataType": "Identity", "operationType": "Create"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/me/displayScoping:
get:
operationId: ui_ScopingCheckResource_isScopingCheckEnabled_2
tags:
- UI Scoping
summary: Is scoping check enabled
description: Is scoping check enabled
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"identityId": "abc-12345", "scopingEnabled": true}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
'/ui/rest/me/features/{feature}':
get:
operationId: ui_FeatureCheckResource_checkFeature
tags:
- UI Me
summary: This endpoint checks if a user has a particular feature enabled
description: This endpoint checks if a user has a particular feature enabled
parameters:
- in: path
name: feature
required: true
description: The feature.
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
example: {"featureName": "LCM_ACCESS_REQUEST"}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/me/home:
get:
operationId: ui_HomePageResource_getHomePageContent
tags:
- UI Me
summary: Get the home page content for the logged in user
description: Get the home page content for the logged in user
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: object
description: HomePageDTO
example: {"quickLinkCards": [{"name": "Example Item", "cssClass": "sailpoint.object.Identity", "label": "example-label", "text": "Example message text", "ariaLabel": "example-ariaLabel", "allowSelf": true, "allowOthers": true, "allowBulk": true, "quickLink": {}}], "widgets": [{"id": "abc-12345", "name": "Example Item", "title": "Example Title"}], "contentOrder": ["example-value"], "cardMaps": [{}], "widgetMaps": [{}]}
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
put:
operationId: ui_HomePageResource_saveHomePageContent
tags:
- UI Me
summary: Save configured home page content for the logged in user
description: Save configured home page content for the logged in user
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: true
example: {"quickLinkCards": [{}], "widgets": [{}], "contentOrder": ["example-value"], "cardMaps": [{}], "widgetMaps": [{}]}
responses:
'200':
description: Request completed successfully.
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/me/mobileQuickLinks:
get:
operationId: ui_MobileQuickLinksResource_getQuickLinkCards
tags:
- UI Quick Links
summary: Get the mobile QuickLinks for the logged in user
description: Get the mobile QuickLinks for the logged in user
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: array
items:
type: object
example: [{"id": "12345", "name": "Example Item", "description": "Sample record"}]
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
/ui/rest/me/quickLinkCards:
get:
operationId: ui_QuickLinkCardsResource_getQuickLinkCards
tags:
- UI Quick Links
summary: Get the QuickLinkCards for the logged in user
description: Get the QuickLinkCards for the logged in user
parameters:
- in: query
name: all
required: false
description: The all query parameter.
schema:
type: boolean
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
type: array
items:
type: object
example: [{"id": "12345", "name": "Example Item", "description": "Sample record"}]
'400':
description: Bad request.
'401':
description: Unauthorized.
'403':
description: Forbidden.
'500':
description: Internal server error.
put:
operationId: ui_QuickLinkCardsResource_setQuickLinkCards
tags:
- UI Quick Links
summary: Set the user preferred quick link cards
description: Set the user preferred quick link cards
requestBody:
content:
application/json:
schema:
type: object
description: "List