mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-09 04:19:37 +00:00
50204 lines
2.5 MiB
50204 lines
2.5 MiB
openapi: 3.0.1
|
|
info:
|
|
title: Identity Security Cloud V3 API
|
|
description: Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.
|
|
termsOfService: https://developer.sailpoint.com/discuss/tos
|
|
contact:
|
|
name: Developer Relations
|
|
url: https://developer.sailpoint.com/discuss/api-help
|
|
license:
|
|
name: MIT
|
|
url: https://opensource.org/licenses/MIT
|
|
version: 3.0.0
|
|
servers:
|
|
- url: https://{tenant}.api.identitynow.com/v3
|
|
description: This is the production API server.
|
|
variables:
|
|
tenant:
|
|
default: sailpoint
|
|
description: This is the name of your tenant, typically your company's name.
|
|
- url: https://{apiUrl}/v3
|
|
description: This is the V3 API server.
|
|
variables:
|
|
apiUrl:
|
|
default: sailpoint.api.identitynow.com
|
|
description: This is the api url of your tenant
|
|
tags:
|
|
- name: Access Profiles
|
|
description: |
|
|
Use this API to implement and customize access profile functionality.
|
|
With this functionality in place, administrators can create access profiles and configure them for use throughout Identity Security Cloud, enabling users to get the access they need quickly and securely.
|
|
|
|
Access profiles group entitlements, which represent access rights on sources.
|
|
|
|
For example, an Active Directory source in Identity Security Cloud can have multiple entitlements: the first, 'Employees,' may represent the access all employees have at the organization, and a second, 'Developers,' may represent the access all developers have at the organization.
|
|
|
|
An administrator can then create a broader set of access in the form of an access profile, 'AD Developers' grouping the 'Employees' entitlement with the 'Developers' entitlement.
|
|
|
|
When users only need Active Directory employee access, they can request access to the 'Employees' entitlement.
|
|
|
|
When users need both Active Directory employee and developer access, they can request access to the 'AD Developers' access profile.
|
|
|
|
Access profiles are the most important units of access in Identity Security Cloud. Identity Security Cloud uses access profiles in many features, including the following:
|
|
|
|
- Provisioning: When you use the Provisioning Service, lifecycle states and roles both grant access to users in the form of access profiles.
|
|
|
|
- Certifications: You can approve or revoke access profiles in certification campaigns, just like entitlements.
|
|
|
|
- Access Requests: You can assign access profiles to applications, and when a user requests access to the app associated with an access profile and someone approves the request, access is granted to both the application and its associated access profile.
|
|
|
|
- Roles: You can group one or more access profiles into a role to quickly assign access items based on an identity's role.
|
|
|
|
In Identity Security Cloud, administrators can use the Access drop-down menu and select Access Profiles to view, configure, and delete existing access profiles, as well as create new ones.
|
|
Administrators can enable and disable an access profile, and they can also make the following configurations:
|
|
|
|
- Manage Entitlements: Manage the profile's access by adding and removing entitlements.
|
|
|
|
- Access Requests: Configure access profiles to be requestable and establish an approval process for any requests that the access profile be granted or revoked.
|
|
Do not configure an access profile to be requestable without first establishing a secure access request approval process for the access profile.
|
|
|
|
- Multiple Account Options: Define the logic Identity Security Cloud uses to provision access to an identity with multiple accounts on the source.
|
|
|
|
Refer to [Managing Access Profiles](https://documentation.sailpoint.com/saas/help/access/access-profiles.html) for more information about access profiles.
|
|
- name: Access Request Approvals
|
|
description: |
|
|
Use this API to implement and customize access request approval functionality.
|
|
With this functionality in place, administrators can delegate qualified users to review users' requests for access or managers' requests to revoke team members' access to applications, entitlements, or roles.
|
|
This enables more qualified users to review access requests and the others to spend their time on other tasks.
|
|
|
|
In Identity Security Cloud, users can request access to applications, entitlements, and roles, and managers can request that team members' access be revoked.
|
|
For applications and entitlements, administrators can set access profiles to require approval from the access profile owner, the application owner, the source owner, the requesting user's manager, or a governance group for access to be granted or revoked.
|
|
For roles, administrators can also set roles to allow access requests and require approval from the role owner, the requesting user's manager, or a governance group for access to be granted or revoked.
|
|
If the administrator designates a governance group as the required approver, any governance group member can approve the requests.
|
|
|
|
When a user submits an access request, Identity Security Cloud sends the first required approver in the queue an email notification, based on the access request configuration's approval and reminder escalation configuration.
|
|
|
|
In Approvals in Identity Security Cloud, required approvers can view pending access requests under the Requested tab and approve or deny them, or the approvers can reassign the requests to different reviewers for approval.
|
|
If the required approver approves the request and is the only reviewer required, Identity Security Cloud grants or revokes access, based on the request.
|
|
If multiple reviewers are required, Identity Security Cloud sends the request to the next reviewer in the queue, based on the access request configuration's approval reminder and escalation configuration.
|
|
The required approver can then view any completed access requests under the Reviewed tab.
|
|
|
|
Refer to [Access Requests](https://documentation.sailpoint.com/saas/help/requests/index.html) for more information about access request approvals.
|
|
- name: Access Requests
|
|
description: |
|
|
Use this API to implement and customize access request functionality.
|
|
With this functionality in place, users can request access to applications, entitlements, or roles, and managers can request that team members' access be revoked.
|
|
This allows users to get access to the tools they need quickly and securely, and it allows managers to take away access to those tools.
|
|
|
|
Identity Security Cloud's Access Request service allows end users to request access that requires approval before it can be granted to users and enables qualified users to review those requests and approve or deny them.
|
|
|
|
In the Request Center in Identity Security Cloud, users can view available applications, roles, and entitlements and request access to them.
|
|
If the requested tools requires approval, the requests appear as 'Pending' under the My Requests tab until the required approver approves, rejects, or cancels them.
|
|
|
|
Users can use My Requests to track and/or cancel the requests.
|
|
|
|
In My Team on the Identity Security Cloud Home, managers can submit requests to revoke their team members' access.
|
|
They can use the My Requests tab under Request Center to track and/or cancel the requests.
|
|
|
|
Refer to [Requesting Access](https://documentation.sailpoint.com/saas/user-help/requests/requesting_access.html) for more information about access requests.
|
|
- name: Account Activities
|
|
description: |
|
|
Use this API to implement account activity tracking functionality.
|
|
With this functionality in place, users can track source account activity in Identity Security Cloud, which greatly improves traceability in the system.
|
|
|
|
An account activity refers to a log of each action performed on a source account. This is useful for auditing the changes performed on an account throughout its life.
|
|
In Identity Security Cloud's Search, users can search for account activities and select the activity's row to get an overview of the activity's account action and view its progress, its involved sources, and its most basic metadata, such as the identity requesting the option and the recipient.
|
|
|
|
Account activity includes most actions Identity Security Cloud completes on source accounts. Users can search in Identity Security Cloud for the following account action types:
|
|
|
|
- Access Request: These include any access requests the source account is involved in.
|
|
|
|
- Account Attribute Updates: These include updates to a single attribute on an account on a source.
|
|
|
|
- Account State Update: These include locking or unlocking actions on an account on a source.
|
|
|
|
- Certification: These include actions removing an entitlement from an account on a source as a result of the entitlement's revocation during a certification.
|
|
|
|
- Cloud Automated `Lifecyclestate`: These include automated lifecycle state changes that result in a source account's correlated identity being assigned to a different lifecycle state.
|
|
Identity Security Cloud replaces the `Lifecyclestate` variable with the name of the lifecycle state it has moved the account's identity to.
|
|
|
|
- Identity Attribute Update: These include updates to a source account's correlated identity attributes as the result of a provisioning action.
|
|
When you update an identity attribute that also updates an identity's lifecycle state, the cloud automated `Lifecyclestate` event also displays.
|
|
Account Activity does not include attribute updates that occur as a result of aggregation.
|
|
|
|
- Identity Refresh: These include correlated identity refreshes that occur for an account on a source whenever the account's correlated identity profile gets a new role or updates.
|
|
These also include refreshes that occur whenever Identity Security Cloud assigns an application to the account's correlated identity based on the application's being assigned to All Users From Source or Specific Users From Source.
|
|
|
|
- Lifecycle State Refresh: These include the actions that took place when a lifecycle state changed. This event only occurs after a cloud automated `Lifecyclestate` change or a lifecycle state change.
|
|
|
|
- Lifecycle State Change: These include the account activities that result from an identity's manual assignment to a null lifecycle state.
|
|
|
|
- Password Change: These include password changes on sources.
|
|
|
|
Refer to [Account Activity](https://documentation.sailpoint.com/saas/help/search/index.html#account-activity) for more information about account activities.
|
|
- name: Account Usages
|
|
description: |
|
|
Use this API to implement account usage insight functionality.
|
|
With this functionality in place, administrators can gather information and insights about how their tenants' source accounts are being used.
|
|
This allows organizations to get the information they need to start optimizing and securing source account usage.
|
|
- name: Accounts
|
|
description: |
|
|
Use this API to implement and customize account functionality.
|
|
With this functionality in place, administrators can manage users' access across sources in Identity Security Cloud.
|
|
|
|
In Identity Security Cloud, an account refers to a user's account on a supported source.
|
|
This typically includes a unique identifier for the user, a unique password, a set of permissions associated with the source and a set of attributes. Identity Security Cloud loads accounts through the creation of sources in Identity Security Cloud.
|
|
|
|
Administrators can correlate users' identities with the users' accounts on the different sources they use.
|
|
This allows Identity Security Cloud to govern the access of identities and all their correlated accounts securely and cohesively.
|
|
|
|
To view the accounts on a source and their correlated identities, administrators can use the Connections drop-down menu, select Sources, select the relevant source, and select its Account tab.
|
|
|
|
To view and edit source account statuses for an identity in Identity Security Cloud, administrators can use the Identities drop-down menu, select Identity List, select the relevant identity, and select its Accounts tab.
|
|
Administrators can toggle an account's Actions to aggregate the account, enable/disable it, unlock it, or remove it from the identity.
|
|
|
|
Accounts can have the following statuses:
|
|
|
|
- Enabled: The account is enabled. The user can access it.
|
|
|
|
- Disabled: The account is disabled, and the user cannot access it, but the identity is not disabled in Identity Security Cloud. This can occur when an administrator disables the account or when the user's lifecycle state changes.
|
|
|
|
- Locked: The account is locked. This may occur when someone has entered an incorrect password for the account too many times.
|
|
|
|
- Pending: The account is currently updating. This status typically lasts seconds.
|
|
|
|
Administrators can select the source account to view its attributes, entitlements, and the last time the account's password was changed.
|
|
|
|
Refer to [Managing User Accounts](https://documentation.sailpoint.com/saas/help/common/users/user_access.html#managing-user-accounts) for more information about accounts.
|
|
- name: Application Discovery
|
|
description: |
|
|
Use this API to implement application discovery functionality.
|
|
With this functionality in place, you can discover applications within your Okta connector and receive connector recommendations by manually uploading application names.
|
|
- name: Auth Users
|
|
description: |
|
|
Use this API to implement user authentication system functionality.
|
|
With this functionality in place, users can get a user's authentication system details, including their capabilities, and modify those capabilities.
|
|
The user's capabilities refer to their access to different systems, or authorization, within the tenant, like access to certifications (CERT_ADMIN) or reports (REPORT_ADMIN).
|
|
These capabilities also determine a user's access to the different APIs.
|
|
This API provides users with a way to determine a user's access and make quick and easy changes to that access.
|
|
- name: Branding
|
|
description: |
|
|
Use this API to implement and customize branding functionality.
|
|
With this functionality in place, administrators can get and manage existing branding items, and they can also create new branding items and configure them for use throughout Identity Security Cloud.
|
|
The Branding APIs provide administrators with a way to customize branding items.
|
|
This customization includes details like their colors, logos, and other information.
|
|
Refer to [Certifications](https://documentation.sailpoint.com/saas/user-help/certifications.html) for more information about certifications.
|
|
- name: Certification Campaign Filters
|
|
description: |
|
|
Use this API to implement the certification campaign filter functionality. These filters can be used to create a certification campaign that includes a subset of your entitlements or users to certify.
|
|
|
|
For example, if for a certification campaign an organization wants to certify only specific users or entitlements, then those can be included/excluded on the basis of campaign filters.
|
|
|
|
For more information about creating a campaign filter, refer to [Creating a Campaign Filter](https://documentation.sailpoint.com/saas/help/certs/campaign_filters.html#creating-a-campaign-filter)
|
|
|
|
You can create campaign filters using any of the following criteria types:
|
|
|
|
- Access Profile : This criteria type includes or excludes access profiles from a campaign.
|
|
|
|
- Account Attribute : This criteria type includes or excludes certification items that match a specified value in an account attribute.
|
|
|
|
- Entitlement : This criteria type includes or excludes entitlements from a campaign.
|
|
|
|
- Identity : This criteria type includes or excludes specific identities from your campaign.
|
|
|
|
- Identity Attribute : This criteria type includes or excludes identities based on whether they have an identity attribute that matches criteria you've chosen.
|
|
|
|
- Role : This criteria type includes or excludes roles, as opposed to identities.
|
|
|
|
- Source : This criteria type includes or excludes entitlements from a source you select.
|
|
|
|
For more information about these criteria types, refer to [Types of Campaign Filters](https://documentation.sailpoint.com/saas/help/certs/campaign_filters.html#types-of-campaign-filters)
|
|
|
|
Once the campaign filter is created, it can be linked while creating the campaign. The generated campaign will have the items to review as per the campaign filter.
|
|
|
|
For example, An inclusion campaign filter is created with a source of Source 1, an operation of Equals, and an entitlement of Entitlement 1. When this filter is selected, only users who have Entitlement 1 are included in the campaign, and only Entitlement 1 is shown in the certification.
|
|
- name: Certification Campaigns
|
|
description: |
|
|
Use this API to implement certification campaign functionality.
|
|
With this functionality in place, administrators can create, customize, and manage certification campaigns for their organizations' use.
|
|
Certification campaigns provide Identity Security Cloud users with an interactive review process they can use to identify and verify access to systems.
|
|
Campaigns help organizations reduce risk of inappropriate access and satisfy audit requirements.
|
|
|
|
A certification refers to Identity Security Cloud's mechanism for reviewing a user's access to entitlements (sets of permissions) and approving or removing that access.
|
|
These certifications serve as a way of showing that a user's access has been reviewed and approved.
|
|
Multiple certifications by different reviewers are often required to approve a user's access.
|
|
A set of multiple certifications is called a certification campaign.
|
|
|
|
For example, an organization may use a Manager Certification campaign as a way of showing that a user's access has been reviewed and approved by multiple managers.
|
|
Once this campaign has been completed, Identity Security Cloud would provision all the access the user needs, nothing more.
|
|
|
|
Identity Security Cloud provides two simple campaign types users can create without using search queries, Manager and Source Owner campaigns:
|
|
|
|
You can create these types of campaigns without using any search queries in Identity Security Cloud:
|
|
|
|
- ManagerCampaign: Identity Security Cloud provides this campaign type as a way to ensure that an identity's access is certified by their managers.
|
|
You only need to provide a name and description to create one.
|
|
|
|
- Source Owner Campaign: Identity Security Cloud provides this campaign type as a way to ensure that an identity's access to a source is certified by its source owners.
|
|
You only need to provide a name and description to create one.
|
|
You can specify the sources whose owners you want involved or just run it across all sources.
|
|
|
|
For more information about these campaign types, refer to [Starting a Manager or Source Owner Campaign](https://documentation.sailpoint.com/saas/help/certs/starting_campaign.html).
|
|
|
|
One useful way to create certification campaigns in Identity Security Cloud is to use a specific search and then run a campaign on the results returned by that search.
|
|
This allows you to be much more specific about whom you are certifying in your campaigns and what access you are certifying in your campaigns.
|
|
For example, you can search for all identities who are managed by "Amanda.Ross" and also have the access to the "Accounting" role and then run a certification campaign based on that search to ensure that the returned identities are appropriately certified.
|
|
|
|
You can use Identity Security Cloud search queries to create these types of campaigns:
|
|
|
|
- Identities: Use this campaign type to review and revoke access items for specific identities.
|
|
You can either build a search query and create a campaign certifying all identities returned by that query, or you can search for individual identities and add those identities to the certification campaign.
|
|
|
|
- Access Items: Use this campaign type to review and revoke a set of roles, access profiles, or entitlements from the identities that have them.
|
|
You can either build a search query and create a campaign certifying all access items returned by that query, or you can search for individual access items and add those items to the certification campaign.
|
|
|
|
- Role Composition: Use this campaign type to review a role's composition, including its title, description, and membership criteria.
|
|
You can either build a search query and create a campaign certifying all roles returned by that query, or you can search for individual roles and add those roles to the certification campaign.
|
|
|
|
- Uncorrelated Accounts: Use this campaign type to certify source accounts that aren't linked to an authoritative identity in Identity Security Cloud.
|
|
You can use this campaign type to view all the uncorrelated accounts for a source and certify them.
|
|
|
|
For more information about search-based campaigns, refer to [Starting a Campaign from Search](https://documentation.sailpoint.com/saas/help/certs/starting_search_campaign.html).
|
|
|
|
Once you have generated your campaign, it becomes available for preview.
|
|
An administrator can review the campaign and make changes, or if it's ready and accurate, activate it.
|
|
|
|
Once the campaign is active, organization administrators or certification administrators can designate other Identity Security Cloud users as certification reviewers.
|
|
Those reviewers can view any of the certifications they either need to review (active) or have already reviewed (completed).
|
|
|
|
When a certification campaign is in progress, certification reviewers see the listed active certifications whose involved identities they can review.
|
|
Reviewers can then make decisions to grant or revoke access, as well as reassign the certification to another reviewer. If the reviewer chooses this option, they must provide a reason for reassignment in the form of a comment.
|
|
|
|
Once a reviewer has made decisions on all the certification's involved access items, he or she must "Sign Off" to complete the review process.
|
|
Doing so converts the certification into read-only status, preventing any further changes to the review decisions and deleting the work item (task) from the reviewer's list of work items.
|
|
|
|
Once all the reviewers have signed off, the certification campaign either completes or, if any reviewers decided to revoke access for any of the involved identities, it moves into a remediation phase.
|
|
In the remediation phase, identities' entitlements are altered to remove any entitlements marked for revocation.
|
|
In this situation, the certification campaign completes once all the remediation requests are completed.
|
|
|
|
The end of a certification campaign is determined by its deadline, its completion status, or by an administrator's decision.
|
|
|
|
For more information about certifications and certification campaigns, refer to [Certifications](https://documentation.sailpoint.com/saas/user-help/certifications.html).
|
|
- name: Certification Summaries
|
|
description: |
|
|
Use this API to implement certification summary functionality.
|
|
With this functionality in place, administrators and designated certification reviewers can review summaries of identity certification campaigns and draw conclusions about the campaigns' scope, security, and effectiveness.
|
|
Implementing certification summary functionality improves organizations' ability to review their [certifications](https://documentation.sailpoint.com/saas/user-help/certifications.html) and helps them satisfy audit and regulatory requirements by enabling them to trace access changes and the decisions made in their review processes.
|
|
|
|
A certification refers to Identity Security Cloud's mechanism for reviewing a user's access to entitlements (sets of permissions) and approving or removing that access.
|
|
These certifications serve as a way of showing that a user's access has been reviewed and approved.
|
|
Multiple certifications by different reviewers are often required to approve a user's access.
|
|
A set of multiple certifications is called a certification campaign.
|
|
|
|
For example, an organization may use a Manager Certification as a way of showing that a user's access has been reviewed and approved by their manager, or if the certification is part of a campaign, that the user's access has been reviewed and approved by multiple managers.
|
|
Once this certification has been completed, Identity Security Cloud would provision all the access the user needs, nothing more.
|
|
|
|
Certification summaries provide information about identity certification campaigns such as the identities involved, the number of decisions made, and the access changed.
|
|
For example, an administrator or designated certification reviewer can examine the Manager Certification campaign to get an overview of how many entitlement decisions are made in that campaign as opposed to role decisions, which identities would be affected by changes to the campaign, and how those identities' access would be affected.
|
|
- name: Certifications
|
|
description: |
|
|
Use this API to implement certification functionality.
|
|
With this functionality in place, administrators and designated certification reviewers can review users' access certifications and decide whether to approve access, revoke it, or reassign the review to another reviewer.
|
|
Implementing certifications improves organizations' data security by reducing inappropriate access through a distributed review process and helping them satisfy audit and regulatory requirements.
|
|
|
|
A certification refers to Identity Security Cloud's mechanism for reviewing a user's access to entitlements (sets of permissions) and approving or removing that access.
|
|
These serve as a way of showing that a user's access has been reviewed and approved.
|
|
Multiple certifications by different reviewers are often required to approve a user's access.
|
|
A set of multiple certifications is called a certification campaign.
|
|
|
|
For example, an organization may use a Manager Certification as a way of showing that a user's access has been reviewed and approved by their manager, or if the certification is part of a campaign, that the user's access has been reviewed and approved by multiple managers.
|
|
Once this certification has been completed, Identity Security Cloud would provision all the access the user needs, nothing more.
|
|
|
|
Organization administrators or certification administrators can designate other Identity Security Cloud users as certification reviewers.
|
|
Those reviewers can select the 'Certifications' tab to view any of the certifications they either need to review or have already reviewed under the 'Active' and 'Completed' tabs, respectively.
|
|
|
|
When a certification campaign is in progress, certification reviewers will see certifications listed under 'Active,' where they can review the involved identities.
|
|
Under the 'Decision' column on the right, next to each access item, reviewers can select the checkmark to approve access, select the 'X' to revoke access, or they can toggle the 'More Options' menu to reassign the certification to another reviewer and provide a reason for reassignment in the form of a comment.
|
|
|
|
Once a reviewer has made decisions on all the certification's involved access items, he or she must select 'Sign Off' to complete the review process.
|
|
Doing so converts the certification into read-only status, preventing any further changes to the review decisions and deleting the work item (task) from the reviewer's list of work items.
|
|
|
|
Once all the reviewers have signed off, the certification campaign either completes or, if any reviewers decided to revoke access for any of the involved identities, it moves into a remediation phase. In the remediation phase, identities' entitlements are altered to remove any entitlements marked for revocation.
|
|
In this situation, the certification campaign completes once all the remediation requests are completed.
|
|
- name: Configuration Hub
|
|
description: |
|
|
Upload configurations and manage object mappings between tenants.
|
|
|
|
Configuration files can be managed and deployed using Configuration Hub by uploading a JSON file which contains configuration data.
|
|
|
|
The function of object mapping allows objects with varying names and IDs to be compared. While objects are compared, a user can replace a value in the source tenant with a new value. Object mapping also helps in locating referenced objects to the source object during the drafting process.
|
|
|
|
Refer to [Uploading a Configuration File](https://documentation.sailpoint.com/saas/help/confighub/config_hub.html#uploading-a-configuration-file) for more information about uploading Configuration Files
|
|
|
|
Refer to [Mapping Objects](https://documentation.sailpoint.com/saas/help/confighub/config_hub.html#mapping-objects) for more information about object mappings.
|
|
- name: Connectors
|
|
description: |
|
|
Use this API to implement connector functionality.
|
|
With this functionality in place, administrators can view available connectors.
|
|
|
|
Connectors are the bridges Identity Security Cloud uses to communicate with and aggregate data from sources.
|
|
For example, if it is necessary to set up a connection between Identity Security Cloud and the Active Directory source, a connector can bridge the two and enable Identity Security Cloud to synchronize data between the systems.
|
|
This ensures account entitlements and states are correct throughout the organization.
|
|
|
|
In Identity Security Cloud, administrators can use the Connections drop-down menu and select Sources to view the available source connectors.
|
|
|
|
Refer to [Identity Security Cloud Connectors](https://documentation.sailpoint.com/connectors/identitynow/landingpages/help/landingpages/identitynow_connectivity_landing.html) for more information about the connectors available in Identity Security Cloud.
|
|
|
|
Refer to [SaaS Connectivity](https://developer.sailpoint.com/docs/connectivity/saas-connectivity/) for more information about the SaaS custom connectors that do not need VAs (virtual appliances) to communicate with their sources.
|
|
|
|
Refer to [Managing Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) for more information about using connectors in Identity Security Cloud.
|
|
- name: Global Tenant Security Settings
|
|
description: |
|
|
Use this API to implement and customize global tenant security settings.
|
|
With this functionality in place, administrators can manage the global security settings that a tenant/org has.
|
|
This API can be used to configure the networks and Geographies allowed to access Identity Security Cloud URLs.
|
|
- name: Identity Profiles
|
|
description: |
|
|
Use this API to implement identity profile functionality.
|
|
With this functionality in place, administrators can view identity profiles and their configurations.
|
|
|
|
Identity profiles represent the configurations that can be applied to identities as a way of granting them a set of security and access, as well as defining the mappings between their identity attributes and their source attributes.
|
|
|
|
In Identity Security Cloud, administrators can use the Identities drop-down menu and select Identity Profiles to view the list of identity profiles.
|
|
This list shows some details about each identity profile, along with its status.
|
|
They can select an identity profile to view its settings, its mappings between identity attributes and correlating source account attributes, and its provisioning settings.
|
|
|
|
Refer to [Creating Identity Profiles](https://documentation.sailpoint.com/saas/help/setup/identity_profiles.html) for more information about identity profiles.
|
|
- name: Lifecycle States
|
|
description: |
|
|
Use this API to implement and customize lifecycle state functionality.
|
|
With this functionality in place, administrators can create and configure custom lifecycle states for use across their organizations, which is key to controlling which users have access, when they have access, and the access they have.
|
|
|
|
A lifecycle state describes a user's status in a company. For example, two lifecycle states come by default with Identity Security Cloud: 'Active' and 'Inactive.'
|
|
When an active employee takes an extended leave of absence from a company, his or her lifecycle state may change to 'Inactive,' for security purposes.
|
|
The inactive employee would lose access to all the applications, sources, and sensitive data during the leave of absence, but when the employee returns and becomes active again, all that access would be restored.
|
|
This saves administrators the time that would otherwise be spent provisioning the employee's access to each individual tool, reviewing the employee's certification history, etc.
|
|
|
|
Administrators can create a variety of custom lifecycle states. Refer to [Planning New Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#planning-new-lifecycle-states) for some custom lifecycle state ideas.
|
|
|
|
Administrators must define the criteria for being in each lifecycle state, and they must define how Identity Security Cloud manages users' access to apps and sources for each lifecycle state.
|
|
|
|
In Identity Security Cloud, administrators can manage lifecycle states by going to Admin > Identities > Identity Profile, selecting the identity profile whose lifecycle states they want to manage, selecting the 'Provisioning' tab, and using the left panel to either select the lifecycle state they want to modify or create a new lifecycle state.
|
|
|
|
In the 'Provisioning' tab, administrators can make the following access changes to an identity profile's lifecycle state:
|
|
|
|
- Enable/disable the lifecycle state for the identity profile.
|
|
|
|
- Enable/disable source accounts for the identity profile's lifecycle state.
|
|
|
|
- Add existing access profiles to grant to the identity profiles in that lifecycle state.
|
|
|
|
- Create a new access profile to grant to the identity profile in that lifecycle state.
|
|
|
|
Access profiles granted in a previous lifecycle state are automatically revoked when the identity moves to a new lifecycle state.
|
|
To maintain access across multiple lifecycle states, administrators must grant the access profiles in each lifecycle state.
|
|
For example, if an administrator wants users with the 'HR Employee' identity profile to maintain their building access in both the 'Active' and 'Leave of Absence' lifecycle states, the administrator must grant the access profile for that building access to both lifecycle states.
|
|
|
|
During scheduled refreshes, Identity Security Cloud evaluates lifecycle states to determine whether their assigned identities have the access defined in the lifecycle states' access profiles.
|
|
If the identities are missing access, Identity Security Cloud provisions that access.
|
|
|
|
Administrators can also use the 'Provisioning' tab to configure email notifications for Identity Security Cloud to send whenever an identity with that identity profile has a lifecycle state change.
|
|
Refer to [Configuring Lifecycle State Notifications](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#configuring-lifecycle-state-notifications) for more information on how to do so.
|
|
|
|
An identity's lifecycle state can have four different statuses: the lifecycle state's status can be 'Active,' it can be 'Not Set,' it can be 'Not Valid,' or it 'Does Not Match Technical Name Case.'
|
|
Refer to [Moving Identities into Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#moving-identities-into-lifecycle-states) for more information about these different lifecycle state statuses.
|
|
|
|
Refer to [Setting Up Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html) for more information about lifecycle states.
|
|
- name: Managed Clients
|
|
description: |
|
|
Use this API to implement managed client functionality.
|
|
With this functionality in place, administrators can modify and delete existing managed clients, create new ones, and view and make changes to their log configurations.
|
|
- name: Managed Clusters
|
|
description: |
|
|
Use this API to implement managed cluster functionality.
|
|
With this functionality in place, administrators can modify and delete existing managed clients, get their statuses, and create new ones.
|
|
- name: MFA Configuration
|
|
description: Configure and test multifactor authentication (MFA) methods
|
|
- name: MFA Controller
|
|
description: This API used for multifactor authentication functionality belong to gov-multi-auth service. This controller allow you to verify authentication by specified method
|
|
- name: Non-Employee Lifecycle Management
|
|
description: |
|
|
Use this API to implement non-employee lifecycle management functionality.
|
|
With this functionality in place, administrators can create non-employee records and configure them for use in their organizations.
|
|
This allows organizations to provide secure access to non-employees and control that access.
|
|
|
|
The 'non-employee' term refers to any consultant, contractor, intern, or other user in an organization who is not a full-time permanent employee.
|
|
Organizations can track non-employees' access and activity in Identity Security Cloud by creating and maintaining non-employee sources.
|
|
Organizations can have a maximum of 50 non-employee sources.
|
|
|
|
By using SailPoint's Non-Employee Lifecycle Management functionality, you agree to the following:
|
|
|
|
- SailPoint is not responsible for storing sensitive data.
|
|
You may only add account attributes to non-employee identities that are necessary for business operations and are consistent with your contractual limitations on data that may be sent or stored in Identity Security Cloud.
|
|
|
|
- You are responsible for regularly downloading your list of non-employee accounts for all the sources you create and storing this list of accounts in a managed location to maintain an authoritative system of record and backup data for these accounts.
|
|
|
|
To manage non-employees in Identity Security Cloud, administrators must create a non-employee source and add accounts to the source.
|
|
|
|
To create a non-employee source in Identity Security Cloud, administrators must use the Admin panel to go to Connections > Sources.
|
|
They must then specify 'Non-Employee' in the 'Source Type' field.
|
|
Refer to [Creating a Non-Employee Source](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html#creating-a-non-employee-source) for more details about how to create non-employee sources.
|
|
|
|
To add accounts to a non-employee source in Identity Security Cloud, administrators can select the non-employee source and add the accounts.
|
|
They can also use the 'Manage Non-Employees' widget on their user dashboards to reach the list of sources and then select the non-employee source they want to add the accounts to.
|
|
|
|
Administrators can either add accounts individually or in bulk. Each non-employee source can have a maximum of 20,000 accounts.
|
|
To add accounts in bulk, they must select the 'Bulk Upload' option and upload a CSV file.
|
|
Refer to [Adding Accounts](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html#adding-accounts) for more details about how to add accounts to non-employee sources.
|
|
|
|
Once administrators have created the non-employee source and added accounts to it, they can create identity profiles to generate identities for the non-employee accounts and manage the non-employee identities the same way they would any other identities.
|
|
|
|
Refer to [Managing Non-Employee Sources and Accounts](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html) for more information about non-employee lifecycle management.
|
|
- name: OAuth Clients
|
|
description: |
|
|
Use this API to implement OAuth client functionality.
|
|
With this functionality in place, users with the appropriate security scopes can create and configure OAuth clients to use as a way to obtain authorization to use the Identity Security Cloud REST API.
|
|
Refer to [Authentication](https://developer.sailpoint.com/docs/api/authentication/) for more information about OAuth and how it works with the Identity Security Cloud REST API.
|
|
- name: Password Configuration
|
|
description: |
|
|
Use this API to implement organization password configuration functionality.
|
|
With this functionality in place, organization administrators can create organization-specific password configurations.
|
|
|
|
These configurations include details like custom password instructions, as well as digit token length and duration.
|
|
|
|
Refer to [Configuring User Authentication for Password Resets](https://documentation.sailpoint.com/saas/help/pwd/pwd_reset.html) for more information about organization password configuration functionality.
|
|
- name: Password Dictionary
|
|
description: |
|
|
Use this API to implement password dictionary functionality.
|
|
With this functionality in place, administrators can create password dictionaries to prevent users from using certain words or characters in their passwords.
|
|
|
|
A password dictionary is a list of words or characters that users are prevented from including in their passwords.
|
|
This can help protect users from themselves and force them to create passwords that are not easy to break.
|
|
|
|
A password dictionary must meet the following requirements to for the API to handle them correctly:
|
|
|
|
- It must be in .txt format.
|
|
|
|
- All characters must be UTF-8 characters.
|
|
|
|
- Each line must contain a single word or character with no spaces or whitespace characters.
|
|
|
|
- It must contain at least one line other than the locale string.
|
|
|
|
- Each line must not exceed 128 characters.
|
|
|
|
- The file must not exceed 2500 lines.
|
|
|
|
Administrators should also consider the following when they create their dictionaries:
|
|
|
|
- Lines starting with a # represent comments.
|
|
|
|
- All words in the password dictionary are case-insensitive.
|
|
For example, adding the word "password" to the dictionary also disallows the following: PASSWORD, Password, and PassWord.
|
|
|
|
- The dictionary uses substring matching.
|
|
For example, adding the word "spring" to the dictionary also disallows the following: Spring124, 345SprinG, and 8spring.
|
|
Users can then select 'Change Password' to update their passwords.
|
|
|
|
Administrators must do the following to create a password dictionary:
|
|
|
|
- Create the text file that will contain the prohibited password values.
|
|
|
|
- If the dictionary is not in English, they must add a locale string to the top line: locale:`languageCode`_`countryCode`
|
|
|
|
The languageCode value refers to the language's 2-letter ISO 639-1 code.
|
|
The countryCode value refers to the country's 2-letter ISO 3166-1 code.
|
|
|
|
Refer to this list https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html to see all the available ISO 639-1 language codes and ISO 3166-1 country codes.
|
|
|
|
- Upload the .txt file to Identity Security Cloud with [Update Password Dictionary](https://developer.sailpoint.com/docs/api/v3/put-password-dictionary). Uploading a new file always overwrites the previous dictionary file.
|
|
|
|
Administrators can then specify which password policies check new passwords against the password dictionary by doing the following: In the Admin panel, they can use the Password Mgmt dropdown menu to select Policies, select the policy, and select the 'Prevent use of words in this site's password dictionary' checkbox beside it.
|
|
|
|
Refer to [Configuring Advanced Password Management Options](https://documentation.sailpoint.com/saas/help/pwd/adv_config.html) for more information about password dictionaries.
|
|
- name: Password Management
|
|
description: |
|
|
Use this API to implement password management functionality.
|
|
With this functionality in place, users can manage their identity passwords for all their applications.
|
|
|
|
In Identity Security Cloud, users can select their names in the upper right corner of the page and use the drop-down menu to select Password Manager.
|
|
Password Manager lists the user's identity's applications, possibly grouped to share passwords.
|
|
Users can then select 'Change Password' to update their passwords.
|
|
|
|
Grouping passwords allows users to update their passwords more broadly, rather than requiring them to update each password individually.
|
|
Password Manager may list the applications and sources in the following groups:
|
|
|
|
- Password Group: This refers to a group of applications that share a password.
|
|
For example, a user can use the same password for Google Drive, Google Mail, and YouTube.
|
|
Updating the password for the password group updates the password for all its included applications.
|
|
|
|
- Multi-Application Source: This refers to a source with multiple applications that share a password.
|
|
For example, a user can have a source, G Suite, that includes the Google Calendar, Google Drive, and Google Mail applications.
|
|
Updating the password for the multi-application source updates the password for all its included applications.
|
|
|
|
- Applications: These are applications that do not share passwords with other applications.
|
|
|
|
An organization may require some authentication for users to update their passwords.
|
|
Users may be required to answer security questions or use a third-party authenticator before they can confirm their updates.
|
|
|
|
Refer to [Managing Passwords](https://documentation.sailpoint.com/saas/user-help/accounts/passwords.html) for more information about password management.
|
|
- name: Password Policies
|
|
description: |
|
|
Use these APIs to implement password policies functionality.
|
|
These APIs allow you to define the policy parameters for choosing passwords.
|
|
|
|
IdentityNow comes with a default policy that you can modify to define the password requirements your users must meet to log in to IdentityNow, such as requiring a minimum password length, including special characters, and disallowing certain patterns.
|
|
If you have licensed Password Management, you can create additional password policies beyond the default one to manage passwords for supported sources in your org.
|
|
|
|
In the Identity Security Cloud Admin panel, administrators can use the Password Mgmt dropdown menu to select Sync Groups.
|
|
Refer to [Managing Password Policies](https://documentation.sailpoint.com/saas/help/pwd/pwd_policies/pwd_policies.html) for more information about password policies.
|
|
- name: Password Sync Groups
|
|
description: |
|
|
Use this API to implement password sync group functionality.
|
|
With this functionality in place, administrators can group sources into password sync groups so that all their applications share the same password.
|
|
This allows users to update the password for all the applications in a sync group if they want, rather than updating each password individually.
|
|
|
|
A password sync group is a group of applications that shares a password.
|
|
Administrators create these groups by grouping the applications' sources.
|
|
For example, an administrator can group the ActiveDirectory, GitHub, and G Suite sources together so that all those sources' applications can also be grouped to share a password.
|
|
A user can then update his or her password for ActiveDirectory, GitHub, Gmail, Google Drive, and Google Calendar all at once, rather then updating each one individually.
|
|
|
|
The following are required for administrators to create a password sync group in Identity Security Cloud:
|
|
|
|
- At least two direct connect sources connected to Identity Security Cloud and configured for Password Management.
|
|
|
|
- Each authentication source in a sync group must have at least one application. Refer to [Adding and Resetting Application Passwords](https://documentation.sailpoint.com/saas/help/pwd/adv_config.html#adding-and-resetting-application-passwords) for more information about adding applications to sources.
|
|
|
|
- At least one password policy. Refer to [Managing Password Policies](https://documentation.sailpoint.com/saas/help/pwd/policies.html) for more information about password policies.
|
|
|
|
In the Admin panel in Identity Security Cloud, administrators can use the Password Mgmt dropdown menu to select Sync Groups.
|
|
To create a sync group, administrators must provide a name, choose a password policy to be enforced across the sources in the sync group, and select the sources to include in the sync group.
|
|
|
|
Administrators can also delete sync groups in Identity Security Cloud, but they should know the following before they do:
|
|
|
|
- Passwords related to the associated sources will become independent, so changing one will not change the others anymore.
|
|
|
|
- Passwords for the sources' connected applications will also become independent.
|
|
|
|
- Password policies assigned to the sync group are then assigned directly to the associated sources.
|
|
To change the password policy for a source, administrators must edit it directly.
|
|
|
|
Once the password sync group has been created, users can update the password for the group in Password Manager.
|
|
|
|
Refer to [Managing Password Sync Groups](https://documentation.sailpoint.com/saas/help/pwd/sync_grps.html) for more information about password sync groups.
|
|
- name: Personal Access Tokens
|
|
description: |
|
|
Use this API to implement personal access token (PAT) functionality.
|
|
With this functionality in place, users can use PATs as an alternative to passwords for authentication in Identity Security Cloud.
|
|
|
|
PATs embed user information into the client ID and secret.
|
|
This replaces the API clients' need to store and provide a username and password to establish a connection, improving Identity Security Cloud organizations' integration security.
|
|
|
|
In Identity Security Cloud, users can do the following to create and manage their PATs: Select the dropdown menu under their names, select Preferences, and then select Personal Access Tokens.
|
|
They must then provide a description about the token's purpose.
|
|
They can then select 'Create Token' at the bottom of the page to generate and view the Secret and Client ID.
|
|
|
|
Refer to [Managing Personal Access Tokens](https://documentation.sailpoint.com/saas/help/common/generate_tokens.html) for more information about PATs.
|
|
- name: Public Identities
|
|
description: |
|
|
Use this API in conjunction with [Public Identites Config](https://developer.sailpoint.com/docs/api/v3/public-identities-config/) to enable non-administrators to view identities' publicly visible attributes.
|
|
With this functionality in place, non-administrators can view identity attributes other than the default attributes (email, lifecycle state, and manager), depending on which identity attributes their organization administrators have made public.
|
|
This can be helpful for access approvers, certification reviewers, managers viewing their direct reports' access, and source owners viewing their tasks.
|
|
- name: Public Identities Config
|
|
description: |
|
|
Use this API to implement public identity configuration functionality.
|
|
With this functionality in place, administrators can make up to 5 identity attributes publicly visible so other non-administrator users can see the relevant information they need to make decisions.
|
|
This can be helpful for approvers making approvals, certification reviewers, managers viewing their direct reports' access, and source owners viewing their tasks.
|
|
|
|
By default, non-administrators can select an identity and view the following attributes: email, lifecycle state, and manager.
|
|
However, it may be helpful for a non-administrator reviewer to see other identity attributes like department, region, title, etc.
|
|
Administrators can use this API to make those necessary identity attributes public to non-administrators.
|
|
|
|
For example, a non-administrator deciding whether to approve another identity's request for access to the Workday application, whose access may be restricted to members of the HR department, would want to know whether the identity is a member of the HR department.
|
|
If an administrator has used [Update Public Identity Config](https://developer.sailpoint.com/docs/api/v3/update-public-identity-config/) to make the "department" attribute public, the approver can see the department and make a decision without requesting any more information.
|
|
- name: Reports Data Extraction
|
|
description: |
|
|
Use this API to implement reports lifecycle managing and monitoring.
|
|
With this functionality in place, users can run reports, view their results, and cancel reports in progress.
|
|
This can be potentially helpful for auditing purposes.
|
|
- name: Requestable Objects
|
|
description: |
|
|
Use this API to implement requestable object functionality.
|
|
With this functionality in place, administrators can determine which access items can be requested with the [Access Request APIs](https://developer.sailpoint.com/docs/api/v3/access-requests/), along with their statuses.
|
|
This can be helpful for administrators who are implementing and customizing access request functionality as a way of checking which items are requestable as they are created, assigned, and made available.
|
|
- name: Roles
|
|
description: |
|
|
Use this API to implement and customize role functionality.
|
|
With this functionality in place, administrators can create roles and configure them for use throughout Identity Security Cloud.
|
|
Identity Security Cloud can use established criteria to automatically assign the roles to qualified users. This enables users to get all the access they need quickly and securely and administrators to spend their time on other tasks.
|
|
|
|
Entitlements represent the most granular level of access in Identity Security Cloud.
|
|
Access profiles represent the next level and often group entitlements.
|
|
Roles represent the broadest level of access and often group access profiles.
|
|
|
|
For example, an Active Directory source in Identity Security Cloud can have multiple entitlements: the first, 'Employees,' may represent the access all employees have at the organization, and a second, 'Developers,' may represent the access all developers have at the organization.
|
|
|
|
An administrator can then create a broader set of access in the form of an access profile, 'AD Developers' grouping the 'Employees' entitlement with the 'Developers' entitlement.
|
|
|
|
An administrator can then create an even broader set of access in the form of a role grouping the 'AD Developers' access profile with another profile, 'GitHub Developers,' grouping entitlements for the GitHub source.
|
|
|
|
When users only need Active Directory employee access, they can request access to the 'Employees' entitlement.
|
|
|
|
When users need both Active Directory employee and developer access, they can request access to the 'AD Developers' access profile.
|
|
|
|
When users need both the 'AD Developers' access profile and the 'GitHub Developers' access profile, they can request access to the role grouping both.
|
|
|
|
Roles often represent positions within organizations.
|
|
For example, an organization's accountant can access all the tools the organization's accountants need with the 'Accountant' role.
|
|
If the accountant switches to engineering, a qualified member of the organization can quickly revoke the accountant's 'Accountant' access and grant access to the 'Engineer' role instead, granting access to all the tools the organization's engineers need.
|
|
|
|
In Identity Security Cloud, adminstrators can use the Access drop-down menu and select Roles to view, configure, and delete existing roles, as well as create new ones.
|
|
Administrators can enable and disable the role, and they can also make the following configurations:
|
|
|
|
- Manage Access: Manage the role's access by adding or removing access profiles.
|
|
|
|
- Define Assignment: Define the criteria Identity Security Cloud uses to assign the role to identities.
|
|
Use the first option, 'Standard Criteria,' to provide specific criteria for assignment like specific account attributes, entitlements, or identity attributes.
|
|
Use the second, 'Identity List,' to specify the identities for assignment.
|
|
|
|
- Access Requests: Configure roles to be requestable and establish an approval process for any requests that the role be granted or revoked.
|
|
Do not configure a role to be requestable without establishing a secure access request approval process for that role first.
|
|
|
|
Refer to [Working with Roles](https://documentation.sailpoint.com/saas/help/access/roles.html) for more information about roles.
|
|
- name: Saved Search
|
|
description: |
|
|
Use this API to implement saved search functionality.
|
|
With saved search functionality in place, users can save search queries and then view those saved searches, as well as rerun them.
|
|
|
|
Search queries in Identity Security Cloud can grow very long and specific, which can make reconstructing them difficult or tedious, so it can be especially helpful to save search queries.
|
|
It also opens the possibility to configure Identity Security Cloud to run the saved queries on a schedule, which is essential to detecting user information and access changes throughout an organization's tenant and across all its sources.
|
|
Refer to [Scheduled Search](https://developer.sailpoint.com/docs/api/v3/scheduled-search/) for more information about running saved searches on a schedule.
|
|
|
|
In Identity Security Cloud, users can save searches under a name, and then they can access that saved search and run it again when they want.
|
|
|
|
Refer to [Managing Saved Searches](https://documentation.sailpoint.com/saas/help/search/saved-searches.html) for more information about saving searches and using them.
|
|
- name: Scheduled Search
|
|
description: |
|
|
Use this API to implement scheduled search functionality.
|
|
With scheduled search functionality in place, users can run saved search queries on their tenants on a schedule, and Identity Security Cloud emails them the search results.
|
|
Users can also share these search results with other users by email by adding those users as subscribers, or those users can subscribe themselves.
|
|
|
|
One of the greatest benefits of saving searches is the ability to run those searches on a schedule.
|
|
This is essential for organizations to constantly detect any changes to user information or access throughout their tenants and across all their sources.
|
|
For example, the manager Amanda Ross can schedule a saved search "manager.name:amanda.ross AND attributes.location:austin" on a schedule to regularly stay aware of changes with the Austin employees reporting to her.
|
|
Identity Security Cloud emails her the search results when the search runs, so she can work on other tasks instead of actively running this search.
|
|
|
|
In Identity Security Cloud, scheduling a search involves a subscription.
|
|
Users can create a subscription for a saved search and schedule it to run daily, weekly, or monthly (you can only use one schedule option at a time).
|
|
The user can add other identities as subscribers so when the scheduled search runs, the subscribers and the user all receive emails.
|
|
|
|
By default, subscriptions exclude detailed results from the emails, for security purposes.
|
|
Including detailed results about user access in an email may expose sensitive information.
|
|
However, the subscription creator can choose to include the information in the emails.
|
|
|
|
By default, Identity Security Cloud sends emails to the subscribers even when the searches do not return new results.
|
|
However, the subscription creator can choose to suppress these empty emails.
|
|
|
|
Users can also subscribe to saved searches that already have existing subscriptions so they receive emails when the searches run.
|
|
A saved search can have up to 10 subscriptions configured at a time.
|
|
|
|
The subscription creator can enable, disable, or delete the subscription.
|
|
|
|
Refer to [Subscribing to Saved Searches](https://documentation.sailpoint.com/saas/help/search/saved-searches.html#subscribing-to-saved-searches) for more information about scheduling searches and subscribing to them.
|
|
- name: Search
|
|
description: |
|
|
Use this API to implement search functionality.
|
|
With search functionality in place, users can search their tenants for nearly any information from throughout their organizations.
|
|
|
|
Identity Security Cloud enables organizations to store user data from across all their connected sources and manage the users' access, so the ability to query and filter that data is essential.
|
|
Its search goes through all those sources and finds the results quickly and specifically.
|
|
|
|
The search query is flexible - it can be very broad or very narrow.
|
|
The search only returns results for searchable objects it is filtering for.
|
|
The following objects are searchable: identities, roles, access profiles, entitlements, events, and account activities.
|
|
By default, no filter is applied, so a search for "Ad" returns both the identity "Adam.Archer" as well as the role "Administrator."
|
|
|
|
Users can further narrow their results by using Identity Security Cloud's specific syntax and punctuation to structure their queries.
|
|
For example, the query "attributes.location:austin AND NOT manager.name:amanda.ross" returns all results associated with the Austin location, but it excludes those associated with the manager Amanda Ross.
|
|
Refer to [Building a Search Query](https://documentation.sailpoint.com/saas/help/search/building-query.html) for more information about how to construct specific search queries.
|
|
|
|
Refer to [Using Search](https://documentation.sailpoint.com/saas/help/search/index.html) for more information about Identity Security Cloud's search and its different possibilities.
|
|
|
|
The search feature uses Elasticsearch as a datastore and query engine.
|
|
The power of Elasticsearch makes this feature suitable for ad-hoc reporting.
|
|
However, data from the operational databases (ex. identities, roles, events, etc) has to be ingested into Elasticsearch.
|
|
This ingestion process introduces a latency from when the operational data is created to when it is available in search.
|
|
Depending on the system load, this can take a few seconds to a few minutes.
|
|
Please keep this latency in mind when you use search.
|
|
- name: Search Attribute Configuration
|
|
description: |
|
|
Use this API to implement search attribute configuration functionality, along with [Search](https://developer.sailpoint.com/docs/api/v3/search).
|
|
With this functionality in place, administrators can create custom search attributes that and run extended searches based on those attributes to further narrow down their searches and get the information and insights they want.
|
|
|
|
Identity Security Cloud (ISC) enables organizations to store user data from across all their connected sources and manage the users' access, so the ability to query and filter that data is essential.
|
|
Its search goes through all those sources and finds the results quickly and specifically.
|
|
|
|
The search query is flexible - it can be very broad or very narrow.
|
|
The search only returns results for searchable objects it is filtering for.
|
|
The following objects are searchable: identities, roles, access profiles, entitlements, events, and account activities.
|
|
By default, no filter is applied, so a search for "Ad" returns both the identity "Adam.Archer" as well as the role "Administrator."
|
|
|
|
Users can further narrow their results by using ISC's specific syntax and punctuation to structure their queries.
|
|
For example, the query "attributes.location:austin AND NOT manager.name:amanda.ross" returns all results associated with the Austin location, but it excludes those associated with the manager Amanda Ross.
|
|
Refer to [Building a Search Query](https://documentation.sailpoint.com/saas/help/search/building-query.html) for more information about how to construct specific search queries.
|
|
|
|
Refer to [Using Search](https://documentation.sailpoint.com/saas/help/search/index.html) for more information about ISC's search and its different possibilities.
|
|
|
|
With Search Attribute Configuration, administrators can create, manage, and run searches based on the attributes they want to search.
|
|
- name: Segments
|
|
description: |
|
|
Use this API to implement and customize access request segment functionality.
|
|
With this functionality in place, administrators can create and manage access request segments.
|
|
Segments provide organizations with a way to make the access their users have even more granular - this can simply the access request process for the organization's users and improves security by reducing the risk of overprovisoning access.
|
|
|
|
Segments represent sets of identities, all grouped by specified identity attributes, who are only able to see and access the access items associated with their segments.
|
|
For example, administrators could group all their organization's London office employees into one segment, "London Office Employees," by their shared location.
|
|
The administrators could then define the access items the London employees would need, and the identities in the "London Office Employees" would then only be able to see and access those items.
|
|
|
|
In Identity Security Cloud, administrators can use the 'Access' drop-down menu and select 'Segments' to reach the 'Access Requests Segments' page.
|
|
This page lists all the existing access request segments, along with their statuses, enabled or disabled.
|
|
Administrators can use this page to create, edit, enable, disable, and delete segments.
|
|
To create a segment, an administrator must provide a name, define the identities grouped in the segment, and define the items the identities in the segment can access.
|
|
These items can be access profiles, roles, or entitlements.
|
|
|
|
When administrators use the API to create and manage segments, they use a JSON expression in the `visibilityCriteria` object to define the segment's identities and access items.
|
|
|
|
Refer to [Managing Access Request Segments](https://documentation.sailpoint.com/saas/help/requests/segments.html) for more information about segments in Identity Security Cloud.
|
|
- name: Service Desk Integration
|
|
description: |
|
|
Use this API to build an integration between Identity Security Cloud and a service desk ITSM (IT service management) solution.
|
|
Once an administrator builds this integration between Identity Security Cloud and a service desk, users can use Identity Security Cloud to raise and track tickets that are synchronized between Identity Security Cloud and the service desk.
|
|
|
|
In Identity Security Cloud, administrators can create a service desk integration (sometimes also called an SDIM, or Service Desk Integration Module) by going to Admin > Connections > Service Desk and selecting 'Create.'
|
|
|
|
To create a Generic Service Desk integration, for example, administrators must provide the required information on the General Settings page, the Connectivity and Authentication information, Ticket Creation information, Status Mapping information, and Requester Source information on the Configure page.
|
|
Refer to [Integrating SailPoint with Generic Service Desk](https://documentation.sailpoint.com/connectors/generic_sd/help/integrating_generic_service_desk/intro.html) for more information about the process of setting up a Generic Service Desk in Identity Security Cloud.
|
|
|
|
Administrators can create various service desk integrations, all with their own nuances.
|
|
The following service desk integrations are available:
|
|
|
|
- [Atlassian Cloud Jira Service Management](https://documentation.sailpoint.com/connectors/atlassian/jira_cloud/help/integrating_jira_cloud_sd/introduction.html)
|
|
|
|
- [Atlassian Server Jira Service Management](https://documentation.sailpoint.com/connectors/atlassian/jira_server/help/integrating_jira_server_sd/introduction.html)
|
|
|
|
- [BMC Helix ITSM Service Desk](https://documentation.sailpoint.com/connectors/bmc/helix_ITSM_sd/help/integrating_bmc_helix_itsm_sd/intro.html)
|
|
|
|
- [BMC Helix Remedyforce Service Desk](https://documentation.sailpoint.com/connectors/bmc/helix_remedyforce_sd/help/integrating_bmc_helix_remedyforce_sd/intro.html)
|
|
|
|
- [Generic Service Desk](https://documentation.sailpoint.com/connectors/generic_sd/help/integrating_generic_service_desk/intro.html)
|
|
|
|
- [ServiceNow Service Desk](https://documentation.sailpoint.com/connectors/servicenow/sdim/help/integrating_servicenow_sdim/intro.html)
|
|
|
|
- [Zendesk Service Desk](https://documentation.sailpoint.com/connectors/zendesk/help/integrating_zendesk_sd/introduction.html)
|
|
- name: SOD Policies
|
|
description: |
|
|
Use this API to implement and manage "separation of duties" (SOD) policies.
|
|
With SOD policy functionality in place, administrators can organize the access in their tenants to prevent individuals from gaining conflicting or excessive access.
|
|
|
|
"Separation of duties" refers to the concept that people shouldn't have conflicting sets of access - all their access should be configured in a way that protects your organization's assets and data.
|
|
For example, people who record monetary transactions shouldn't be able to issue payment for those transactions.
|
|
Any changes to major system configurations should be approved by someone other than the person requesting the change.
|
|
|
|
Organizations can use "separation of duties" (SOD) policies to enforce and track their internal security rules throughout their tenants.
|
|
These SOD policies limit each user's involvement in important processes and protects the organization from individuals gaining excessive access.
|
|
|
|
To create SOD policies in Identity Security Cloud, administrators use 'Search' and then access 'Policies'.
|
|
To create a policy, they must configure two lists of access items. Each access item can only be added to one of the two lists.
|
|
They can search for the entitlements they want to add to these access lists.
|
|
|
|
>Note: You can have a maximum of 500 policies of any type (including general policies) in your organization. In each access-based SOD policy, you can have a maximum of 50 entitlements in each access list.
|
|
|
|
Once a SOD policy is in place, if an identity has access items on both lists, a SOD violation will trigger.
|
|
These violations are included in SOD violation reports that other users will see in emails at regular intervals if they're subscribed to the SOD policy.
|
|
The other users can then better help to enforce these SOD policies.
|
|
|
|
To create a subscription to a SOD policy in Identity Security Cloud, administrators use 'Search' and then access 'Layers'.
|
|
They can create a subscription to the policy and schedule it to run at a regular interval.
|
|
|
|
Refer to [Managing Policies](https://documentation.sailpoint.com/saas/help/sod/manage-policies.html) for more information about SOD policies.
|
|
|
|
Refer to [Subscribe to a SOD Policy](https://documentation.sailpoint.com/saas/help/sod/policy-violations.html#subscribe-to-an-sod-policy) for more information about SOD policy subscriptions.
|
|
- name: SOD Violations
|
|
description: |
|
|
Use this API to check for current "separation of duties" (SOD) policy violations as well as potential future SOD policy violations.
|
|
With SOD violation functionality in place, administrators can get information about current SOD policy violations and predict whether an access change will trigger new violations, which helps to prevent them from occurring at all.
|
|
|
|
"Separation of duties" refers to the concept that people shouldn't have conflicting sets of access - all their access should be configured in a way that protects your organization's assets and data.
|
|
For example, people who record monetary transactions shouldn't be able to issue payment for those transactions.
|
|
Any changes to major system configurations should be approved by someone other than the person requesting the change.
|
|
|
|
Organizations can use "separation of duties" (SOD) policies to enforce and track their internal security rules throughout their tenants.
|
|
These SOD policies limit each user's involvement in important processes and protects the organization from individuals gaining excessive access.
|
|
|
|
Once a SOD policy is in place, if an identity has conflicting access items, a SOD violation will trigger.
|
|
These violations are included in SOD violation reports that other users will see in emails at regular intervals if they're subscribed to the SOD policy.
|
|
The other users can then better help to enforce these SOD policies.
|
|
|
|
Administrators can use the SOD violations APIs to check a set of identities for any current SOD violations, and they can use them to check whether adding an access item would potentially trigger a SOD violation.
|
|
This second option is a good way to prevent SOD violations from triggering at all.
|
|
|
|
Refer to [Handling Policy Violations](https://documentation.sailpoint.com/saas/help/sod/policy-violations.html) for more information about SOD policy violations.
|
|
- name: Source Usages
|
|
description: |
|
|
Use this API to implement source usage insight functionality.
|
|
With this functionality in place, administrators can gather information and insights about how their tenants' sources are being used.
|
|
This allows organizations to get the information they need to start optimizing and securing source usage.
|
|
- name: Sources
|
|
description: |
|
|
Use this API to implement and customize source functionality.
|
|
With source functionality in place, organizations can use Identity Security Cloud to connect their various sources and user data sets and manage access across all those different sources in a secure, scalable way.
|
|
|
|
[Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) refer to the Identity Security Cloud representations for external applications, databases, and directory management systems that maintain their own sets of users, like Dropbox, GitHub, and Workday, for example.
|
|
Organizations may use hundreds, if not thousands, of different source systems, and any one employee within an organization likely has a different user record on each source, often with different permissions on many of those records.
|
|
Connecting these sources to Identity Security Cloud makes it possible to manage user access across them all.
|
|
Then, if a new hire starts at an organization, Identity Security Cloud can grant the new hire access to all the sources they need.
|
|
If an employee moves to a new department and needs access to new sources but no longer needs access to others, Identity Security Cloud can grant the necessary access and revoke the unnecessary access for all the employee's various sources.
|
|
If an employee leaves the company, Identity Security Cloud can revoke access to all the employee's various source accounts immediately.
|
|
These are just a few examples of the many ways that source functionality makes identity governance easier, more efficient, and more secure.
|
|
|
|
In Identity Security Cloud, administrators can create configure, manage, and edit sources, and they can designate other users as source admins to be able to do so.
|
|
They can also designate users as source sub-admins, who can perform the same source actions but only on sources associated with their governance groups.
|
|
Admins go to Connections > Sources to see a list of the existing source representations in their organizations.
|
|
They can create new sources or select existing ones.
|
|
|
|
To create a new source, the following must be specified: Source Name, Description, Source Owner, and Connection Type.
|
|
Refer to [Configuring a Source](https://documentation.sailpoint.com/saas/help/accounts/loading_data.html#configuring-a-source) for more information about the source configuration process.
|
|
|
|
Identity Security Cloud connects with its sources either by a direct communication with the source server (connection information specific to the source must be provided) or a flat file feed, a CSV file containing all the relevant information about the accounts to be loaded in.
|
|
Different sources use different connectors to share data with Identity Security Cloud, and each connector's setup process is specific to that connector.
|
|
SailPoint has built a number of connectors to come out of the box and connect to the most common sources, and SailPoint actively maintains these connectors.
|
|
Refer to [Identity Security Cloud Connectors](https://documentation.sailpoint.com/connectors/identitynow/landingpages/help/landingpages/identitynow_connectivity_landing.html) for more information about these SailPoint supported connectors.
|
|
Refer to the following links for more information about two useful connectors:
|
|
|
|
- [JDBC Connector](https://documentation.sailpoint.com/connectors/jdbc/help/integrating_jdbc/introduction.html): This customizable connector an directly connect to databases that support JDBC (Java Database Connectivity).
|
|
|
|
- [Web Services Connector](https://documentation.sailpoint.com/connectors/webservices/help/integrating_webservices/introduction.html): This connector can directly connect to databases that support Web Services.
|
|
|
|
Refer to [SaaS Connectivity](https://developer.sailpoint.com/docs/connectivity/saas-connectivity/) for more information about SailPoint's new connectivity framework that makes it easy to build and manage custom connectors to SaaS sources.
|
|
|
|
When admins select existing sources, they can view the following information about the source:
|
|
|
|
- Associated connections (any associated identity profiles, apps, or references to the source in a transform).
|
|
|
|
- Associated user accounts. These accounts are linked to their identities - this provides a more complete picture of each user's access across sources.
|
|
|
|
- Associated entitlements (sets of access rights on sources).
|
|
|
|
- Associated access profiles (groupings of entitlements).
|
|
|
|
The user account data and the entitlements update with each data aggregation from the source.
|
|
Organizations generally run scheduled, automated data aggregations to ensure that their data is always in sync between their sources and their Identity Security Cloud tenants so an access change on a source is detected quickly in Identity Security Cloud.
|
|
Admins can view a history of these aggregations, and they can also run manual imports.
|
|
Refer to [Loading Account Data](https://documentation.sailpoint.com/saas/help/accounts/loading_data.html) for more information about manual and scheduled aggregations.
|
|
|
|
Admins can also make changes to determine which user account data Identity Security Cloud collects from the source and how it correlates that account data with identity data.
|
|
To define which account attributes the source shares with Identity Security Cloud, admins can edit the account schema on the source.
|
|
Refer to [Managing Source Account Schemas](https://documentation.sailpoint.com/saas/help/accounts/schema.html) for more information about source account schemas and how to edit them.
|
|
To define the mapping between the source account attributes and their correlating identity attributes, admins can edit the correlation configuration on the source.
|
|
Refer to [Assigning Source Accounts to Identities](https://documentation.sailpoint.com/saas/help/accounts/correlation.html) for more information about this correlation process between source accounts and identities.
|
|
|
|
Admins can also delete sources, but they must first ensure that the sources no longer have any active connections: the source must not be associated with any identity profile or any app, and it must not be referenced by any transform.
|
|
Refer to [Deleting Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html#deleting-sources) for more information about deleting sources.
|
|
|
|
Well organized, mapped out connections between sources and Identity Security Cloud are essential to achieving comprehensive identity access governance across all the source systems organizations need.
|
|
Refer to [Managing Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) for more information about all the different things admins can do with sources once they are connected.
|
|
- name: Tagged Objects
|
|
description: |
|
|
Use this API to implement object tagging functionality.
|
|
With object tagging functionality in place, any user in an organization can use tags as a way to group objects together and find them more quickly when the user searches Identity Security Cloud.
|
|
|
|
In Identity Security Cloud, users can search their tenants for information and add tags objects they find.
|
|
Tagging an object provides users with a way of grouping objects together and makes it easier to find these objects in the future.
|
|
|
|
For example, if a user is searching for an entitlement that grants a risky level of access to Active Directory, it's possible that the user may have to search through hundreds of entitlements to find the correct one.
|
|
Once the user finds that entitlement, the user can add a tag to the entitlement, "AD_RISKY" to make it easier to find the entitlement again.
|
|
The user can add the same tag to multiple objects the user wants to group together for an easy future search, and the user can also do so in bulk.
|
|
When the user wants to find that tagged entitlement again, the user can search for "tags:AD_RISKY" to find all objects with that tag.
|
|
|
|
With the API, you can tag even more different object types than you can in Identity Security Cloud (access profiles, entitlements, identities, and roles).
|
|
You can use the API to tag all these objects:
|
|
|
|
- Access profiles
|
|
|
|
- Applications
|
|
|
|
- Certification campaigns
|
|
|
|
- Entitlements
|
|
|
|
- Identities
|
|
|
|
- Roles
|
|
|
|
- SOD (separation of duties) policies
|
|
|
|
- Sources
|
|
|
|
You can also use the API to directly find, create, and manage tagged objects without using search queries.
|
|
|
|
There are limits to tags:
|
|
|
|
- You can have up to 500 different tags in your tenant.
|
|
|
|
- You can apply up to 30 tags to one object.
|
|
|
|
- You can have up to 10,000 tag associations, pairings of 1 tag to 1 object, in your tenant.
|
|
|
|
Because of these limits, it is recommended that you work with your governance experts and security teams to establish a list of tags that are most expressive of governance objects and access managed by Identity Security Cloud.
|
|
|
|
These are the types of information often expressed in tags:
|
|
|
|
- Affected departments
|
|
|
|
- Compliance and regulatory categories
|
|
|
|
- Remediation urgency levels
|
|
|
|
- Risk levels
|
|
|
|
Refer to [Tagging Items in Search](https://documentation.sailpoint.com/saas/help/search/index.html?h=tags#tagging-items-in-search) for more information about tagging objects in Identity Security Cloud.
|
|
- name: Transforms
|
|
description: |
|
|
The purpose of this API is to expose functionality for the manipulation of Transform objects.
|
|
Transforms are a form of configurable objects which define an easy way to manipulate attribute data without having
|
|
to write code. These endpoints don't require API calls to other resources, audit service is used for keeping track
|
|
of which users have made changes to the Transforms.
|
|
|
|
Refer to [Transforms](https://developer.sailpoint.com/docs/extensibility/transforms/) for more information about transforms.
|
|
- name: Work Items
|
|
description: |
|
|
Use this API to implement work item functionality.
|
|
With this functionality in place, users can manage their work items (tasks).
|
|
|
|
Work items refer to the tasks users see in Identity Security Cloud's Task Manager.
|
|
They can see the pending work items they need to complete, as well as the work items they have already completed.
|
|
Task Manager lists the work items along with the involved sources, identities, accounts, and the timestamp when the work item was created.
|
|
For example, a user may see a pending 'Create an Account' work item for the identity Fred.Astaire in GitHub for Fred's GitHub account, fred-astaire-sp.
|
|
Once the user completes the work item, the work item will be listed with his or her other completed work items.
|
|
|
|
To complete work items, users can use their dashboards and select the 'My Tasks' widget.
|
|
The widget will list any work items they need to complete, and they can select the work item from the list to review its details.
|
|
When they complete the work item, they can select 'Mark Complete' to add it to their list of completed work items.
|
|
|
|
Refer to [Task Manager](https://documentation.sailpoint.com/saas/user-help/task_manager.html) for more information about work items, including the different types of work items users may need to complete.
|
|
- name: Workflows
|
|
description: |
|
|
Workflows allow administrators to create custom automation scripts directly within Identity Security Cloud. These automation scripts respond to [event triggers](https://developer.sailpoint.com/docs/extensibility/event-triggers/#how-to-get-started-with-event-triggers) and perform a series of actions to perform tasks that are either too cumbersome or not available in the Identity Security Cloud UI. Workflows can be configured via a graphical user interface within Identity Security Cloud, or by creating and uploading a JSON formatted script to the Workflow service. The Workflows API collection provides the necessary functionality to create, manage, and test your workflows via REST.
|
|
paths:
|
|
/access-profiles:
|
|
get:
|
|
operationId: listAccessProfiles
|
|
tags:
|
|
- Access Profiles
|
|
summary: List Access Profiles
|
|
description: |-
|
|
Use this API to get a list of access profiles.
|
|
>**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank.
|
|
parameters:
|
|
- in: query
|
|
name: for-subadmin
|
|
schema:
|
|
type: string
|
|
description: |-
|
|
If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID, or the special value **me**, which is shorthand for the calling identity's ID.
|
|
|
|
A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an identity that is not a subadmin.
|
|
example: 8c190e6787aa4ed9a90bd9d5344523fb
|
|
required: false
|
|
- in: query
|
|
name: limit
|
|
description: |-
|
|
Note that for this API the maximum value for limit is 50.
|
|
See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
required: false
|
|
example: 50
|
|
schema:
|
|
type: integer
|
|
format: int32
|
|
minimum: 0
|
|
maximum: 50
|
|
default: 50
|
|
- in: query
|
|
name: offset
|
|
description: |-
|
|
Offset into the full result set. Usually specified with *limit* to paginate through the results.
|
|
See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
required: false
|
|
example: 0
|
|
schema:
|
|
type: integer
|
|
format: int32
|
|
minimum: 0
|
|
default: 0
|
|
- in: query
|
|
name: count
|
|
description: |-
|
|
If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.
|
|
|
|
Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.
|
|
|
|
See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
required: false
|
|
example: true
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
- in: query
|
|
name: filters
|
|
schema:
|
|
type: string
|
|
description: |-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
**id**: *eq, in*
|
|
|
|
**name**: *eq, sw*
|
|
|
|
**created**: *gt, lt, ge, le*
|
|
|
|
**modified**: *gt, lt, ge, le*
|
|
|
|
**owner.id**: *eq, in*
|
|
|
|
**requestable**: *eq*
|
|
|
|
**source.id**: *eq, in*
|
|
|
|
Composite operators supported: *and, or*
|
|
|
|
Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names.
|
|
example: name eq "SailPoint Support"
|
|
required: false
|
|
- in: query
|
|
name: sorters
|
|
schema:
|
|
type: string
|
|
format: comma-separated
|
|
description: |-
|
|
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
|
|
|
Sorting is supported for the following fields: **name, created, modified**
|
|
example: name,-modified
|
|
required: false
|
|
- in: query
|
|
name: for-segment-ids
|
|
schema:
|
|
type: string
|
|
format: comma-separated
|
|
description: |-
|
|
If present and not empty, additionally filters access profiles to those which are assigned to the segment(s) with the specified IDs.
|
|
|
|
If segmentation is currently unavailable, specifying this parameter results in an error.
|
|
example: 0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d
|
|
required: false
|
|
- in: query
|
|
name: include-unsegmented
|
|
schema:
|
|
type: boolean
|
|
default: true
|
|
description: Indicates whether the response list should contain unsegmented access profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.
|
|
example: false
|
|
required: false
|
|
responses:
|
|
'200':
|
|
description: List of access profiles.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
description: Access Profile
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The ID of the Access Profile
|
|
example: 2c91808a7190d06e01719938fcd20792
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
description: Name of the Access Profile
|
|
example: Employee-database-read-write
|
|
description:
|
|
type: string
|
|
nullable: true
|
|
description: Information about the Access Profile
|
|
example: Collection of entitlements to read/write the employee database
|
|
created:
|
|
type: string
|
|
description: Date the Access Profile was created
|
|
format: date-time
|
|
example: '2021-03-01T22:32:58.104Z'
|
|
readOnly: true
|
|
modified:
|
|
type: string
|
|
description: Date the Access Profile was last modified.
|
|
format: date-time
|
|
example: '2021-03-02T20:22:28.104Z'
|
|
readOnly: true
|
|
enabled:
|
|
type: boolean
|
|
default: true
|
|
description: Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement.
|
|
example: true
|
|
owner:
|
|
type: object
|
|
nullable: false
|
|
description: The owner of this object.
|
|
properties:
|
|
type:
|
|
type: string
|
|
enum:
|
|
- IDENTITY
|
|
description: Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result.
|
|
example: IDENTITY
|
|
id:
|
|
type: string
|
|
description: Identity id
|
|
example: 2c9180a46faadee4016fb4e018c20639
|
|
name:
|
|
type: string
|
|
description: Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result.
|
|
example: support
|
|
source:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The ID of the Source with with which the Access Profile is associated
|
|
example: 2c91809773dee3610173fdb0b6061ef4
|
|
type:
|
|
type: string
|
|
enum:
|
|
- SOURCE
|
|
description: The type of the Source, will always be SOURCE
|
|
example: SOURCE
|
|
name:
|
|
type: string
|
|
description: The display name of the associated Source
|
|
example: ODS-AD-SOURCE
|
|
entitlements:
|
|
type: array
|
|
nullable: true
|
|
description: A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement.
|
|
items:
|
|
type: object
|
|
description: Entitlement including a specific set of access.
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: Entitlement's DTO type.
|
|
enum:
|
|
- ENTITLEMENT
|
|
example: ENTITLEMENT
|
|
id:
|
|
type: string
|
|
description: Entitlement's ID.
|
|
example: 2c91809773dee32014e13e122092014e
|
|
name:
|
|
type: string
|
|
nullable: true
|
|
description: Entitlement's display name.
|
|
example: CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local
|
|
requestable:
|
|
type: boolean
|
|
default: true
|
|
description: Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value **false** in this field results in a 400 error.
|
|
example: true
|
|
accessRequestConfig:
|
|
type: object
|
|
nullable: true
|
|
properties:
|
|
commentsRequired:
|
|
type: boolean
|
|
description: Whether the requester of the containing object must provide comments justifying the request
|
|
example: true
|
|
nullable: true
|
|
default: false
|
|
denialCommentsRequired:
|
|
type: boolean
|
|
description: Whether an approver must provide comments when denying the request
|
|
example: true
|
|
nullable: true
|
|
default: false
|
|
approvalSchemes:
|
|
type: array
|
|
nullable: true
|
|
description: List describing the steps in approving the request
|
|
items:
|
|
type: object
|
|
properties:
|
|
approverType:
|
|
type: string
|
|
enum:
|
|
- APP_OWNER
|
|
- OWNER
|
|
- SOURCE_OWNER
|
|
- MANAGER
|
|
- GOVERNANCE_GROUP
|
|
description: |-
|
|
Describes the individual or group that is responsible for an approval step. Values are as follows.
|
|
**APP_OWNER**: The owner of the Application
|
|
|
|
**OWNER**: Owner of the associated Access Profile or Role
|
|
|
|
**SOURCE_OWNER**: Owner of the Source associated with an Access Profile
|
|
|
|
**MANAGER**: Manager of the Identity making the request
|
|
|
|
**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field
|
|
example: GOVERNANCE_GROUP
|
|
approverId:
|
|
type: string
|
|
nullable: true
|
|
description: Id of the specific approver, used only when approverType is GOVERNANCE_GROUP
|
|
example: 46c79819-a69f-49a2-becb-12c971ae66c6
|
|
revocationRequestConfig:
|
|
type: object
|
|
nullable: true
|
|
properties:
|
|
approvalSchemes:
|
|
type: array
|
|
nullable: true
|
|
description: List describing the steps in approving the revocation request
|
|
items:
|
|
$ref: '#/paths/~1access-profiles/get/responses/200/content/application~1json/schema/items/properties/accessRequestConfig/properties/approvalSchemes/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/access/AccessProfileApprovalScheme.yaml
|
|
segments:
|
|
type: array
|
|
nullable: true
|
|
items:
|
|
type: string
|
|
description: List of IDs of segments, if any, to which this Access Profile is assigned.
|
|
example:
|
|
- f7b1b8a3-5fed-4fd4-ad29-82014e137e19
|
|
- 29cb6c06-1da8-43ea-8be4-b3125f248f2a
|
|
provisioningCriteria:
|
|
type: object
|
|
nullable: true
|
|
description: Defines matching criteria for an Account to be provisioned with a specific Access Profile
|
|
properties:
|
|
operation:
|
|
type: string
|
|
enum:
|
|
- EQUALS
|
|
- NOT_EQUALS
|
|
- CONTAINS
|
|
- HAS
|
|
- AND
|
|
- OR
|
|
description: Supported operations on ProvisioningCriteria
|
|
example: EQUALS
|
|
attribute:
|
|
type: string
|
|
description: Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error.
|
|
example: email
|
|
nullable: true
|
|
value:
|
|
type: string
|
|
nullable: true
|
|
description: String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type.
|
|
example: carlee.cert1c9f9b6fd@mailinator.com
|
|
children:
|
|
type: array
|
|
items:
|
|
type: object
|
|
description: Defines matching criteria for an Account to be provisioned with a specific Access Profile
|
|
properties:
|
|
operation:
|
|
$ref: '#/paths/~1access-profiles/get/responses/200/content/application~1json/schema/items/properties/provisioningCriteria/properties/operation'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/access/ProvisioningCriteriaOperation.yaml
|
|
attribute:
|
|
type: string
|
|
description: Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error.
|
|
example: email
|
|
nullable: true
|
|
value:
|
|
type: string
|
|
nullable: true
|
|
description: String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type.
|
|
example: carlee.cert1c9f9b6fd@mailinator.com
|
|
children:
|
|
type: array
|
|
items:
|
|
type: object
|
|
description: Defines matching criteria for an Account to be provisioned with a specific Access Profile
|
|
properties:
|
|
operation:
|
|
$ref: '#/paths/~1access-profiles/get/responses/200/content/application~1json/schema/items/properties/provisioningCriteria/properties/operation'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/access/ProvisioningCriteriaOperation.yaml
|
|
attribute:
|
|
type: string
|
|
description: Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error.
|
|
example: email
|
|
nullable: true
|
|
value:
|
|
type: string
|
|
description: String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type.
|
|
example: carlee.cert1c9f9b6fd@mailinator.com
|
|
children:
|
|
type: string
|
|
description: Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes.
|
|
example: null
|
|
nullable: true
|
|
nullable: true
|
|
description: Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes.
|
|
example: null
|
|
nullable: true
|
|
description: Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes.
|
|
example: null
|
|
required:
|
|
- owner
|
|
- name
|
|
- source
|
|
'400':
|
|
description: Client Error - Returned if the request body is invalid.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/400/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ErrorResponseDto.yaml
|
|
'401':
|
|
description: Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
error:
|
|
description: A message describing the error
|
|
example: 'JWT validation failed: JWT is expired'
|
|
'403':
|
|
description: Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/400/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ErrorResponseDto.yaml
|
|
examples:
|
|
'403':
|
|
summary: An example of a 403 response object
|
|
value:
|
|
detailCode: 403 Forbidden
|
|
trackingId: b21b1f7ce4da4d639f2c62a57171b427
|
|
messages:
|
|
- locale: en-US
|
|
localeOrigin: DEFAULT
|
|
text: The server understood the request but refuses to authorize it.
|
|
'429':
|
|
description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
message:
|
|
description: A message describing the error
|
|
example: ' Rate Limit Exceeded '
|
|
'500':
|
|
description: Internal Server Error - Returned if there is an unexpected error.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/400/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ErrorResponseDto.yaml
|
|
examples:
|
|
'500':
|
|
summary: An example of a 500 response object
|
|
value:
|
|
detailCode: 500.0 Internal Fault
|
|
trackingId: b21b1f7ce4da4d639f2c62a57171b427
|
|
messages:
|
|
- locale: en-US
|
|
localeOrigin: DEFAULT
|
|
text: An internal fault occurred.
|
|
security:
|
|
- userAuth:
|
|
- idn:access-profile:read
|
|
- applicationAuth:
|
|
- idn:access-profile:read
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- ROLE_ADMIN
|
|
- ROLE_SUBADMIN
|
|
- SOURCE_ADMIN
|
|
- SOURCE_SUBADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$ForSubadmin = "8c190e6787aa4ed9a90bd9d5344523fb" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID, or the special value **me**, which is shorthand for the calling identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an identity that is not a subadmin. (optional)
|
|
$Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50)
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
$Filters = "name eq "SailPoint Support"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Composite operators supported: *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional)
|
|
$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional)
|
|
$ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters access profiles to those which are assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional)
|
|
$IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true)
|
|
|
|
# List Access Profiles
|
|
|
|
try {
|
|
Get-AccessProfiles
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-AccessProfiles -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessProfiles"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
post:
|
|
operationId: createAccessProfile
|
|
tags:
|
|
- Access Profiles
|
|
summary: Create Access Profile
|
|
description: |-
|
|
Use this API to create an access profile.
|
|
A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile's Source.
|
|
The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters.
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1access-profiles/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/access/AccessProfile.yaml
|
|
responses:
|
|
'201':
|
|
description: Access profile created.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1access-profiles/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/access/AccessProfile.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:access-profile:manage
|
|
- applicationAuth:
|
|
- idn:access-profile:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- ROLE_ADMIN
|
|
- ROLE_SUBADMIN
|
|
- SOURCE_ADMIN
|
|
- SOURCE_SUBADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$AccessProfile = @"
|
|
{
|
|
"owner" : {
|
|
"name" : "support",
|
|
"id" : "2c9180a46faadee4016fb4e018c20639",
|
|
"type" : "IDENTITY"
|
|
},
|
|
"entitlements" : [ {
|
|
"name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local",
|
|
"id" : "2c91809773dee32014e13e122092014e",
|
|
"type" : "ENTITLEMENT"
|
|
}, {
|
|
"name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local",
|
|
"id" : "2c91809773dee32014e13e122092014e",
|
|
"type" : "ENTITLEMENT"
|
|
} ],
|
|
"created" : "2021-03-01T22:32:58.104Z",
|
|
"description" : "Collection of entitlements to read/write the employee database",
|
|
"source" : {
|
|
"name" : "ODS-AD-SOURCE",
|
|
"id" : "2c91809773dee3610173fdb0b6061ef4",
|
|
"type" : "SOURCE"
|
|
},
|
|
"enabled" : true,
|
|
"revocationRequestConfig" : {
|
|
"approvalSchemes" : [ {
|
|
"approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6",
|
|
"approverType" : "GOVERNANCE_GROUP"
|
|
}, {
|
|
"approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6",
|
|
"approverType" : "GOVERNANCE_GROUP"
|
|
} ]
|
|
},
|
|
"segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ],
|
|
"accessRequestConfig" : {
|
|
"commentsRequired" : true,
|
|
"approvalSchemes" : [ {
|
|
"approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6",
|
|
"approverType" : "GOVERNANCE_GROUP"
|
|
}, {
|
|
"approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6",
|
|
"approverType" : "GOVERNANCE_GROUP"
|
|
} ],
|
|
"denialCommentsRequired" : true
|
|
},
|
|
"name" : "Employee-database-read-write",
|
|
"provisioningCriteria" : {
|
|
"children" : [ {
|
|
"children" : [ {
|
|
"children" : "children",
|
|
"attribute" : "email",
|
|
"operation" : "EQUALS",
|
|
"value" : "carlee.cert1c9f9b6fd@mailinator.com"
|
|
}, {
|
|
"children" : "children",
|
|
"attribute" : "email",
|
|
"operation" : "EQUALS",
|
|
"value" : "carlee.cert1c9f9b6fd@mailinator.com"
|
|
} ],
|
|
"attribute" : "email",
|
|
"operation" : "EQUALS",
|
|
"value" : "carlee.cert1c9f9b6fd@mailinator.com"
|
|
}, {
|
|
"children" : [ {
|
|
"children" : "children",
|
|
"attribute" : "email",
|
|
"operation" : "EQUALS",
|
|
"value" : "carlee.cert1c9f9b6fd@mailinator.com"
|
|
}, {
|
|
"children" : "children",
|
|
"attribute" : "email",
|
|
"operation" : "EQUALS",
|
|
"value" : "carlee.cert1c9f9b6fd@mailinator.com"
|
|
} ],
|
|
"attribute" : "email",
|
|
"operation" : "EQUALS",
|
|
"value" : "carlee.cert1c9f9b6fd@mailinator.com"
|
|
} ],
|
|
"attribute" : "email",
|
|
"operation" : "EQUALS",
|
|
"value" : "carlee.cert1c9f9b6fd@mailinator.com"
|
|
},
|
|
"modified" : "2021-03-02T20:22:28.104Z",
|
|
"id" : "2c91808a7190d06e01719938fcd20792",
|
|
"requestable" : true
|
|
}
|
|
"@
|
|
|
|
# Create Access Profile
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile
|
|
New-AccessProfile-AccessProfile $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# New-AccessProfile -AccessProfile $AccessProfile
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-AccessProfile"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/access-profiles/{id}:
|
|
get:
|
|
operationId: getAccessProfile
|
|
tags:
|
|
- Access Profiles
|
|
summary: Get an Access Profile
|
|
description: This API returns an Access Profile by its ID.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listAccessProfiles
|
|
schema:
|
|
type: string
|
|
description: ID of the Access Profile
|
|
example: 2c9180837ca6693d017ca8d097500149
|
|
responses:
|
|
'200':
|
|
description: An AccessProfile
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1access-profiles/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/access/AccessProfile.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:access-profile:read
|
|
- applicationAuth:
|
|
- idn:access-profile:read
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- ROLE_ADMIN
|
|
- ROLE_SUBADMIN
|
|
- SOURCE_ADMIN
|
|
- SOURCE_SUBADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Access Profile
|
|
|
|
# Get an Access Profile
|
|
|
|
try {
|
|
Get-AccessProfile-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-AccessProfile -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessProfile"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
patch:
|
|
operationId: patchAccessProfile
|
|
tags:
|
|
- Access Profiles
|
|
summary: Patch a specified Access Profile
|
|
description: |-
|
|
This API updates an existing Access Profile. The following fields are patchable:
|
|
|
|
**name**
|
|
|
|
**description**
|
|
|
|
**enabled**
|
|
|
|
**owner**
|
|
|
|
**requestable**
|
|
|
|
**accessRequestConfig**
|
|
|
|
**revokeRequestConfig**
|
|
|
|
**segments**
|
|
|
|
**entitlements**
|
|
|
|
**provisioningCriteria**
|
|
|
|
**source** (must be updated with entitlements belonging to new source in the same API call)
|
|
|
|
If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example "Replace Source" in the examples dropdown.
|
|
|
|
A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer.
|
|
> The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters.
|
|
|
|
> You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile's source.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: ID of the Access Profile to patch
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listAccessProfiles
|
|
schema:
|
|
type: string
|
|
example: 2c91808a7813090a017814121919ecca
|
|
requestBody:
|
|
content:
|
|
application/json-patch+json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
description: A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)
|
|
required:
|
|
- op
|
|
- path
|
|
properties:
|
|
op:
|
|
type: string
|
|
description: The operation to be performed
|
|
enum:
|
|
- add
|
|
- remove
|
|
- replace
|
|
- move
|
|
- copy
|
|
- test
|
|
example: replace
|
|
path:
|
|
type: string
|
|
description: A string JSON Pointer representing the target path to an element to be affected by the operation
|
|
example: /description
|
|
value:
|
|
oneOf:
|
|
- type: string
|
|
example: New description
|
|
title: string
|
|
- type: boolean
|
|
example: true
|
|
title: boolean
|
|
- type: integer
|
|
example: 300
|
|
title: integer
|
|
- type: object
|
|
title: object
|
|
example:
|
|
attributes:
|
|
name: philip
|
|
- type: array
|
|
title: array
|
|
items:
|
|
anyOf:
|
|
- type: string
|
|
- type: integer
|
|
- type: object
|
|
example:
|
|
- '001'
|
|
- '002'
|
|
- '003'
|
|
description: The value to be used for the operation, required for "add" and "replace" operations
|
|
example: New description
|
|
examples:
|
|
Add Entitlements:
|
|
description: Add one or more entitlements to the end of the list
|
|
value:
|
|
- op: add
|
|
path: /entitlements
|
|
value:
|
|
- id: 2c9180857725c14301772a93bb77242d
|
|
type: ENTITLEMENT
|
|
name: AD User Group
|
|
Insert Entitlement:
|
|
description: Add an entitlement at the beginning of the entitlement list
|
|
value:
|
|
- op: add
|
|
path: /entitlements/0
|
|
value:
|
|
id: 2c9180857725c14301772a93bb77242d
|
|
type: ENTITLEMENT
|
|
name: AD User Group
|
|
Replace Entitlements:
|
|
description: Replace all entitlements with a new list of entitlements
|
|
value:
|
|
- op: replace
|
|
path: /entitlements
|
|
value:
|
|
- id: 2c9180857725c14301772a93bb77242d
|
|
type: ENTITLEMENT
|
|
name: AD User Group
|
|
Remove Entitlement:
|
|
description: Remove the first entitlement in the list
|
|
value:
|
|
- op: remove
|
|
path: /entitlements/0
|
|
Replace Source:
|
|
description: Change the source and the entitlements of the access profile
|
|
value:
|
|
- op: replace
|
|
path: /source
|
|
value:
|
|
id: 2c9180887671ff8c01767b4671fb7d5e
|
|
type: SOURCE
|
|
name: Employees
|
|
- op: replace
|
|
path: /entitlements
|
|
value:
|
|
- id: 2c9180877677453d01767b4b08f63386
|
|
type: ENTITLEMENT
|
|
name: DevRel
|
|
required: true
|
|
responses:
|
|
'200':
|
|
description: Responds with the Access Profile as updated.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1access-profiles/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/access/AccessProfile.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:access-profile:manage
|
|
- applicationAuth:
|
|
- idn:access-profile:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- SOURCE_ADMIN
|
|
- SOURCE_SUBADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to patch
|
|
# JsonPatchOperation[] |
|
|
$JsonPatchOperation = @"{
|
|
"op" : "replace",
|
|
"path" : "/description",
|
|
"value" : "New description"
|
|
}"@
|
|
|
|
|
|
# Patch a specified Access Profile
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
|
|
Update-AccessProfile-Id $Id -JsonPatchOperation $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Update-AccessProfile -Id $Id -JsonPatchOperation $JsonPatchOperation
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AccessProfile"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
delete:
|
|
operationId: deleteAccessProfile
|
|
tags:
|
|
- Access Profiles
|
|
summary: Delete the specified Access Profile
|
|
description: |-
|
|
This API deletes an existing Access Profile.
|
|
|
|
The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned.
|
|
|
|
A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: ID of the Access Profile to delete
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listAccessProfiles
|
|
schema:
|
|
type: string
|
|
example: 2c91808a7813090a017814121919ecca
|
|
responses:
|
|
'204':
|
|
description: No content - indicates the request was successful but there is no content to be returned in the response.
|
|
'400':
|
|
description: Returned when an access profile cannot be deleted as it's being used.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
detailCode:
|
|
type: string
|
|
description: Fine-grained error code providing more detail of the error.
|
|
example: 400.1 Bad Request Content
|
|
trackingId:
|
|
type: string
|
|
description: Unique tracking id for the error.
|
|
example: e7eab60924f64aa284175b9fa3309599
|
|
messages:
|
|
type: array
|
|
description: Generic localized reason for error
|
|
items:
|
|
type: object
|
|
properties:
|
|
locale:
|
|
type: string
|
|
description: The locale for the message text, a BCP 47 language tag.
|
|
example: en-US
|
|
nullable: true
|
|
localeOrigin:
|
|
type: string
|
|
enum:
|
|
- DEFAULT
|
|
- REQUEST
|
|
- null
|
|
description: An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.
|
|
example: DEFAULT
|
|
nullable: true
|
|
text:
|
|
type: string
|
|
description: Actual text of the error message in the indicated locale.
|
|
example: The request was syntactically correct but its content is semantically invalid.
|
|
causes:
|
|
type: array
|
|
description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
|
items:
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/400/content/application~1json/schema/properties/messages/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ErrorMessageDto.yaml
|
|
examples:
|
|
400.2.1.0 Object in use by another:
|
|
description: Returned when an access profile cannot be deleted as it's being used
|
|
value:
|
|
detailCode: 400.2.1.0 Object in use by another
|
|
trackingId: c9c1033c55b84ebc9e93e926dcf8b8b3
|
|
messages:
|
|
- locale: en-US
|
|
localeOrigin: DEFAULT
|
|
text: The "testAccessProfile" access profile can't be deleted because it's in use.
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:access-profile:manage
|
|
- applicationAuth:
|
|
- idn:access-profile:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- SOURCE_ADMIN
|
|
- SOURCE_SUBADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to delete
|
|
|
|
# Delete the specified Access Profile
|
|
|
|
try {
|
|
Remove-AccessProfile-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Remove-AccessProfile -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-AccessProfile"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/access-profiles/bulk-delete:
|
|
post:
|
|
operationId: deleteAccessProfilesInBulk
|
|
summary: Delete Access Profile(s)
|
|
tags:
|
|
- Access Profiles
|
|
description: |-
|
|
This endpoint initiates a bulk deletion of one or more access profiles.
|
|
When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information.
|
|
This endpoint can only bulk delete up to a limit of 50 access profiles per request.
|
|
By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted.
|
|
A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they're able to administer.
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
accessProfileIds:
|
|
description: List of IDs of Access Profiles to be deleted.
|
|
type: array
|
|
items:
|
|
type: string
|
|
example:
|
|
- 2c9180847812e0b1017817051919ecca
|
|
- 2c9180887812e0b201781e129f151816
|
|
bestEffortOnly:
|
|
description: If **true**, silently skip over any of the specified Access Profiles if they cannot be deleted because they are in use. If **false**, no deletions will be attempted if any of the Access Profiles are in use.
|
|
type: boolean
|
|
example: true
|
|
example:
|
|
bestEffortOnly: true
|
|
accessProfileIds:
|
|
- 2c91808876438bb2017668b91919ecca
|
|
- 2c91808876438ba801766e129f151816
|
|
responses:
|
|
'200':
|
|
description: Returned only if **bestEffortOnly** is **false**, and one or more Access Profiles are in use.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
taskId:
|
|
type: string
|
|
description: ID of the task which is executing the bulk deletion. This can be passed to the **/task-status** API to track status.
|
|
example: 2c9180867817ac4d017817c491119a20
|
|
pending:
|
|
type: array
|
|
description: List of IDs of Access Profiles which are pending deletion.
|
|
items:
|
|
type: string
|
|
example:
|
|
- 2c91808876438bbb017668c21919ecca
|
|
- 2c91808876438bb201766e129f151816
|
|
inUse:
|
|
type: array
|
|
description: List of usages of Access Profiles targeted for deletion.
|
|
items:
|
|
type: object
|
|
properties:
|
|
accessProfileId:
|
|
type: string
|
|
description: ID of the Access Profile that is in use
|
|
example: 2c91808876438bbb017668c21919ecca
|
|
usedBy:
|
|
type: array
|
|
description: List of references to objects which are using the indicated Access Profile
|
|
items:
|
|
type: object
|
|
description: Role using the access profile.
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: DTO type of role using the access profile.
|
|
enum:
|
|
- ROLE
|
|
example: ROLE
|
|
id:
|
|
type: string
|
|
description: ID of role using the access profile.
|
|
example: 2c8180857a9b3da0017aa03418480f9d
|
|
name:
|
|
type: string
|
|
description: Display name of role using the access profile.
|
|
example: Manager Role
|
|
example:
|
|
pending: []
|
|
inUse:
|
|
- accessProfileId: 2c91808876438ba801766e129f151816
|
|
usages:
|
|
- type: Role
|
|
id: 2c9180887643764201766e9f6e121518
|
|
'202':
|
|
description: Returned if at least one deletion will be performed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1access-profiles~1bulk-delete/post/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/access/AccessProfileBulkDeleteResponse.yaml
|
|
example:
|
|
taskId: 2c91808a7813090a01781412a1119a20
|
|
pending:
|
|
- 2c91808a7813090a017813fe1919ecca
|
|
inUse:
|
|
- accessProfileId: 2c91808876438ba801766e129f151816
|
|
usages:
|
|
- type: Role
|
|
id: 2c9180887643764201766e9f6e121518
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:access-profile:manage
|
|
- applicationAuth:
|
|
- idn:access-profile:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- SOURCE_ADMIN
|
|
- SOURCE_SUBADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$AccessProfileBulkDeleteRequest = @"
|
|
{
|
|
"accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ],
|
|
"bestEffortOnly" : true
|
|
}
|
|
"@
|
|
|
|
# Delete Access Profile(s)
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest
|
|
Remove-AccessProfilesInBulk-AccessProfileBulkDeleteRequest $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Remove-AccessProfilesInBulk -AccessProfileBulkDeleteRequest $AccessProfileBulkDeleteRequest
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-AccessProfilesInBulk"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/access-profiles/{id}/entitlements:
|
|
get:
|
|
operationId: getAccessProfileEntitlements
|
|
tags:
|
|
- Access Profiles
|
|
summary: List Access Profile's Entitlements
|
|
description: |-
|
|
Use this API to get a list of an access profile's entitlements.
|
|
A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile.
|
|
>**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: ID of the access profile containing the entitlements.
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listAccessProfiles
|
|
schema:
|
|
type: string
|
|
example: 2c91808a7813090a017814121919ecca
|
|
- in: query
|
|
name: limit
|
|
description: |-
|
|
Max number of results to return.
|
|
See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
required: false
|
|
example: 250
|
|
schema:
|
|
type: integer
|
|
format: int32
|
|
minimum: 0
|
|
maximum: 250
|
|
default: 250
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
- in: query
|
|
name: filters
|
|
schema:
|
|
type: string
|
|
description: |-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
**id**: *eq, in*
|
|
|
|
**name**: *eq, sw*
|
|
|
|
**attribute**: *eq, sw*
|
|
|
|
**value**: *eq, sw*
|
|
|
|
**created**: *gt, lt, ge, le*
|
|
|
|
**modified**: *gt, lt, ge, le*
|
|
|
|
**owner.id**: *eq, in*
|
|
|
|
**source.id**: *eq, in*
|
|
|
|
Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names.
|
|
example: attribute eq "memberOf"
|
|
required: false
|
|
- in: query
|
|
name: sorters
|
|
schema:
|
|
type: string
|
|
format: comma-separated
|
|
description: |-
|
|
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
|
|
|
Sorting is supported for the following fields: **name, attribute, value, created, modified**
|
|
example: name,-modified
|
|
required: false
|
|
responses:
|
|
'200':
|
|
description: List of entitlements.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The entitlement id
|
|
example: 2c91808874ff91550175097daaec161c
|
|
name:
|
|
type: string
|
|
description: The entitlement name
|
|
example: LauncherTest2
|
|
attribute:
|
|
type: string
|
|
description: The entitlement attribute name
|
|
example: memberOf
|
|
value:
|
|
type: string
|
|
description: The value of the entitlement
|
|
example: CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local
|
|
sourceSchemaObjectType:
|
|
type: string
|
|
description: The object type of the entitlement from the source schema
|
|
example: group
|
|
description:
|
|
type: string
|
|
description: The description of the entitlement
|
|
example: CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local
|
|
privileged:
|
|
type: boolean
|
|
description: True if the entitlement is privileged
|
|
example: true
|
|
cloudGoverned:
|
|
type: boolean
|
|
description: True if the entitlement is cloud governed
|
|
example: true
|
|
created:
|
|
type: string
|
|
description: Time when the entitlement was created
|
|
format: date-time
|
|
example: '2020-10-08T18:33:52.029Z'
|
|
modified:
|
|
type: string
|
|
description: Time when the entitlement was last modified
|
|
format: date-time
|
|
example: '2020-10-08T18:33:52.029Z'
|
|
source:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The source ID
|
|
example: 2c9180827ca885d7017ca8ce28a000eb
|
|
type:
|
|
type: string
|
|
description: The source type, will always be "SOURCE"
|
|
example: SOURCE
|
|
name:
|
|
type: string
|
|
description: The source name
|
|
example: ODS-AD-Source
|
|
attributes:
|
|
type: object
|
|
description: A map of free-form key-value pairs from the source system
|
|
example:
|
|
fieldName: fieldValue
|
|
additionalProperties: true
|
|
segments:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: List of IDs of segments, if any, to which this Entitlement is assigned.
|
|
example:
|
|
- f7b1b8a3-5fed-4fd4-ad29-82014e137e19
|
|
- 29cb6c06-1da8-43ea-8be4-b3125f248f2a
|
|
directPermissions:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1certifications~1%7BcertificationId%7D~1access-review-items~1%7BitemId%7D~1permissions/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/PermissionDto.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:access-profile:read
|
|
- applicationAuth:
|
|
- idn:access-profile:read
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- SOURCE_ADMIN
|
|
- SOURCE_SUBADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "2c91808a7813090a017814121919ecca" # String | ID of the access profile containing the entitlements.
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
$Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional)
|
|
$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional)
|
|
|
|
# List Access Profile's Entitlements
|
|
|
|
try {
|
|
Get-AccessProfileEntitlements-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-AccessProfileEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessProfileEntitlements"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/access-requests:
|
|
post:
|
|
operationId: createAccessRequest
|
|
security:
|
|
- userAuth:
|
|
- idn:access-request:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- USER
|
|
summary: Submit Access Request
|
|
tags:
|
|
- Access Requests
|
|
description: |
|
|
Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes.
|
|
|
|
Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request
|
|
has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it doesn't return an error
|
|
if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected.
|
|
|
|
It's best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can
|
|
be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also
|
|
use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting
|
|
an access request to ensure that you aren't requesting access that is already granted. If you use this API to request access that an identity already has, the API will ignore the request.
|
|
These ignored requests do not display when you use the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) API.
|
|
|
|
There are two types of access request:
|
|
|
|
__GRANT_ACCESS__
|
|
* Can be requested for multiple identities in a single request.
|
|
* Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options.
|
|
* Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others.
|
|
* Roles, access profiles and entitlements can be requested.
|
|
* While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request.
|
|
|
|
__REVOKE_ACCESS__
|
|
* Can only be requested for a single identity at a time.
|
|
* You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning.
|
|
* Does not support self request. Only manager can request to revoke access for their directly managed employees.
|
|
* If a `removeDate` is specified, then the access will be removed on that date and time only for roles, access profiles and entitlements.
|
|
* Roles, access profiles, and entitlements can be requested for revocation.
|
|
* Revoke requests for entitlements are limited to 1 entitlement per access request currently.
|
|
* You can specify a `removeDate` if the access doesn't already have a sunset date. The `removeDate` must be a future date, in the UTC timezone.
|
|
* Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone.
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
requestedFor:
|
|
description: A list of Identity IDs for whom the Access is requested. If it's a Revoke request, there can only be one Identity ID.
|
|
type: array
|
|
items:
|
|
type: string
|
|
example: 2c918084660f45d6016617daa9210584
|
|
requestType:
|
|
$ref: '#/components/schemas/AccessRequest/properties/requestType'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/AccessRequestType.yaml
|
|
requestedItems:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/AccessRequest/properties/requestedItems/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/AccessRequestItem.yaml
|
|
minItems: 1
|
|
maxItems: 25
|
|
clientMetadata:
|
|
type: object
|
|
additionalProperties:
|
|
type: string
|
|
example:
|
|
requestedAppId: 2c91808f7892918f0178b78da4a305a1
|
|
requestedAppName: test-app
|
|
example:
|
|
requestedAppId: 2c91808f7892918f0178b78da4a305a1
|
|
requestedAppName: test-app
|
|
description: Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities.
|
|
required:
|
|
- requestedFor
|
|
- requestedItems
|
|
responses:
|
|
'202':
|
|
description: Access Request Response.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
newRequests:
|
|
description: A list of new access request tracking data mapped to the values requested.
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
requestedFor:
|
|
type: string
|
|
description: The identity id in which the access request is for.
|
|
example: 2c918084660f45d6016617daa9210584
|
|
requestedItemsDetails:
|
|
type: array
|
|
description: The details of the item requested.
|
|
example: |-
|
|
{
|
|
"type": "ENTITLEMENT",
|
|
"id": "779c6fd7171540bba1184e5946112c28"
|
|
}
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: The type of access item requested.
|
|
enum:
|
|
- ACCESS_PROFILE
|
|
- ENTITLEMENT
|
|
- ROLE
|
|
example: ENTITLEMENT
|
|
id:
|
|
type: string
|
|
description: The id of the access item requested.
|
|
example: 779c6fd7171540bba1184e5946112c28
|
|
attributesHash:
|
|
type: string
|
|
description: a hash representation of the access requested, useful for longer term tracking client side.
|
|
example: -1928438224
|
|
accessRequestIds:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: a list of access request identifiers, generally only one will be populated, but high volume requested may result in multiple ids.
|
|
example:
|
|
- 5d3118c518a44ec7805450d53479ccdb
|
|
example:
|
|
- requestedFor: 899fd612ecfc4cf3bf48f14d0afdef89
|
|
requestedItemsDetails:
|
|
- type: ENTITLEMENT
|
|
id: 779c6fd7171540bba1184e5946112c28
|
|
attributesHash: -1928438224
|
|
accessRequestIds:
|
|
- 5d3118c518a44ec7805450d53479ccdb
|
|
existingRequests:
|
|
description: A list of existing access request tracking data mapped to the values requested. This indicates access has already been requested for this item.
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1access-requests/post/responses/202/content/application~1json/schema/properties/newRequests/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/access-requests/AccessRequestTracking.yaml
|
|
example:
|
|
- requestedFor: 899fd612ecfc4cf3bf48f14d0afdef89
|
|
requestedItemsDetails:
|
|
- type: ROLE
|
|
id: 779c6fd7171540bbc1184e5946112c28
|
|
attributesHash: 2843118224
|
|
accessRequestIds:
|
|
- 5d3118c518a44ec7805450d53479ccdc
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$AccessRequest = @"
|
|
{
|
|
"requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ],
|
|
"clientMetadata" : {
|
|
"requestedAppId" : "2c91808f7892918f0178b78da4a305a1",
|
|
"requestedAppName" : "test-app"
|
|
},
|
|
"requestType" : "GRANT_ACCESS",
|
|
"requestedItems" : [ {
|
|
"clientMetadata" : {
|
|
"requestedAppName" : "test-app",
|
|
"requestedAppId" : "2c91808f7892918f0178b78da4a305a1"
|
|
},
|
|
"removeDate" : "2020-07-11T21:23:15Z",
|
|
"comment" : "Requesting access profile for John Doe",
|
|
"id" : "2c9180835d2e5168015d32f890ca1581",
|
|
"type" : "ACCESS_PROFILE"
|
|
}, {
|
|
"clientMetadata" : {
|
|
"requestedAppName" : "test-app",
|
|
"requestedAppId" : "2c91808f7892918f0178b78da4a305a1"
|
|
},
|
|
"removeDate" : "2020-07-11T21:23:15Z",
|
|
"comment" : "Requesting access profile for John Doe",
|
|
"id" : "2c9180835d2e5168015d32f890ca1581",
|
|
"type" : "ACCESS_PROFILE"
|
|
}, {
|
|
"clientMetadata" : {
|
|
"requestedAppName" : "test-app",
|
|
"requestedAppId" : "2c91808f7892918f0178b78da4a305a1"
|
|
},
|
|
"removeDate" : "2020-07-11T21:23:15Z",
|
|
"comment" : "Requesting access profile for John Doe",
|
|
"id" : "2c9180835d2e5168015d32f890ca1581",
|
|
"type" : "ACCESS_PROFILE"
|
|
}, {
|
|
"clientMetadata" : {
|
|
"requestedAppName" : "test-app",
|
|
"requestedAppId" : "2c91808f7892918f0178b78da4a305a1"
|
|
},
|
|
"removeDate" : "2020-07-11T21:23:15Z",
|
|
"comment" : "Requesting access profile for John Doe",
|
|
"id" : "2c9180835d2e5168015d32f890ca1581",
|
|
"type" : "ACCESS_PROFILE"
|
|
}, {
|
|
"clientMetadata" : {
|
|
"requestedAppName" : "test-app",
|
|
"requestedAppId" : "2c91808f7892918f0178b78da4a305a1"
|
|
},
|
|
"removeDate" : "2020-07-11T21:23:15Z",
|
|
"comment" : "Requesting access profile for John Doe",
|
|
"id" : "2c9180835d2e5168015d32f890ca1581",
|
|
"type" : "ACCESS_PROFILE"
|
|
} ]
|
|
}
|
|
"@
|
|
|
|
# Submit Access Request
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest
|
|
New-AccessRequest-AccessRequest $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# New-AccessRequest -AccessRequest $AccessRequest
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-AccessRequest"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/access-requests/cancel:
|
|
post:
|
|
operationId: cancelAccessRequest
|
|
security:
|
|
- userAuth:
|
|
- idn:access-request:cancel
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
tags:
|
|
- Access Requests
|
|
summary: Cancel Access Request
|
|
description: |-
|
|
This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step.
|
|
In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it.
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
description: Request body payload for cancel access request endpoint.
|
|
required:
|
|
- accountActivityId
|
|
- comment
|
|
properties:
|
|
accountActivityId:
|
|
type: string
|
|
description: This refers to the identityRequestId. To successfully cancel an access request, you must provide the identityRequestId.
|
|
example: 2c9180835d2e5168015d32f890ca1581
|
|
comment:
|
|
type: string
|
|
description: Reason for cancelling the pending access request.
|
|
example: I requested this role by mistake.
|
|
example:
|
|
accountActivityId: 2c91808568c529c60168cca6f90c1313
|
|
comment: I requested this role by mistake.
|
|
responses:
|
|
'202':
|
|
description: Accepted - Returned if the request was successfully accepted into the system.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
description: Not Found - returned if the request URL refers to a resource or object that does not exist
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/400/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ErrorResponseDto.yaml
|
|
examples:
|
|
'404':
|
|
summary: An example of a 404 response object
|
|
value:
|
|
detailCode: 404 Not found
|
|
trackingId: b21b1f7ce4da4d639f2c62a57171b427
|
|
messages:
|
|
- locale: en-US
|
|
localeOrigin: DEFAULT
|
|
text: The server did not find a current representation for the target resource.
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$CancelAccessRequest = @"
|
|
{
|
|
"accountActivityId" : "2c9180835d2e5168015d32f890ca1581",
|
|
"comment" : "I requested this role by mistake."
|
|
}
|
|
"@
|
|
|
|
# Cancel Access Request
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest
|
|
Suspend-AccessRequest-CancelAccessRequest $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Suspend-AccessRequest -CancelAccessRequest $CancelAccessRequest
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-AccessRequest"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/access-request-config:
|
|
get:
|
|
operationId: getAccessRequestConfig
|
|
security:
|
|
- userAuth:
|
|
- idn:access-request-config:read
|
|
summary: Get Access Request Configuration
|
|
tags:
|
|
- Access Requests
|
|
description: This endpoint returns the current access-request configuration.
|
|
responses:
|
|
'200':
|
|
description: Access Request Configuration Details.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
approvalsMustBeExternal:
|
|
type: boolean
|
|
description: If this is true, approvals must be processed by an external system. Also, if this is true, it blocks Request Center access requests and returns an error for any user who isn't an org admin.
|
|
default: false
|
|
example: true
|
|
autoApprovalEnabled:
|
|
type: boolean
|
|
description: If this is true and the requester and reviewer are the same, the request is automatically approved.
|
|
default: false
|
|
example: true
|
|
reauthorizationEnabled:
|
|
type: boolean
|
|
description: If this is true, reauthorization will be enforced for appropriately configured access items. Enablement of this feature is currently in a limited state.
|
|
default: false
|
|
example: true
|
|
requestOnBehalfOfConfig:
|
|
type: object
|
|
properties:
|
|
allowRequestOnBehalfOfAnyoneByAnyone:
|
|
type: boolean
|
|
description: If this is true, anyone can request access for anyone.
|
|
default: false
|
|
example: true
|
|
allowRequestOnBehalfOfEmployeeByManager:
|
|
type: boolean
|
|
description: If this is true, a manager can request access for his or her direct reports.
|
|
default: false
|
|
example: true
|
|
approvalReminderAndEscalationConfig:
|
|
type: object
|
|
properties:
|
|
daysUntilEscalation:
|
|
type: integer
|
|
description: Number of days to wait before the first reminder. If no reminders are configured, then this is the number of days to wait before escalation.
|
|
format: int32
|
|
example: 0
|
|
nullable: true
|
|
daysBetweenReminders:
|
|
type: integer
|
|
description: Number of days to wait between reminder notifications.
|
|
format: int32
|
|
example: 0
|
|
nullable: true
|
|
maxReminders:
|
|
type: integer
|
|
description: Maximum number of reminder notification to send to the reviewer before approval escalation.
|
|
format: int32
|
|
minimum: 1
|
|
example: 1
|
|
nullable: true
|
|
fallbackApproverRef:
|
|
$ref: '#/components/schemas/RequestableObject/properties/ownerRef'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/IdentityReferenceWithNameAndEmail.yaml
|
|
entitlementRequestConfig:
|
|
type: object
|
|
properties:
|
|
allowEntitlementRequest:
|
|
type: boolean
|
|
description: If this is true, entitlement requests are allowed.
|
|
default: false
|
|
example: true
|
|
requestCommentsRequired:
|
|
type: boolean
|
|
description: If this is true, comments are required to submit entitlement requests.
|
|
default: false
|
|
example: false
|
|
deniedCommentsRequired:
|
|
type: boolean
|
|
description: If this is true, comments are required to reject entitlement requests.
|
|
default: false
|
|
example: false
|
|
grantRequestApprovalSchemes:
|
|
type: string
|
|
description: |
|
|
Approval schemes for granting entitlement request. This can be empty if no approval is needed.
|
|
Multiple schemes must be comma-separated. The valid schemes are "entitlementOwner", "sourceOwner", "manager" and "`workgroup:{id}`".
|
|
You can use multiple governance groups (workgroups).
|
|
default: sourceOwner
|
|
nullable: true
|
|
example: entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
|
|
# Get Access Request Configuration
|
|
|
|
try {
|
|
Get-AccessRequestConfig
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-AccessRequestConfig
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessRequestConfig"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
put:
|
|
operationId: setAccessRequestConfig
|
|
security:
|
|
- userAuth:
|
|
- idn:access-request-config:update
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
summary: Update Access Request Configuration
|
|
tags:
|
|
- Access Requests
|
|
description: This endpoint replaces the current access-request configuration.
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1access-request-config/get/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/AccessRequestConfig.yaml
|
|
responses:
|
|
'200':
|
|
description: Access Request Configuration Details.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1access-request-config/get/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/AccessRequestConfig.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$AccessRequestConfig = @"
|
|
{
|
|
"requestOnBehalfOfConfig" : {
|
|
"allowRequestOnBehalfOfEmployeeByManager" : true,
|
|
"allowRequestOnBehalfOfAnyoneByAnyone" : true
|
|
},
|
|
"approvalReminderAndEscalationConfig" : {
|
|
"fallbackApproverRef" : {
|
|
"name" : "Alison Ferguso",
|
|
"id" : "5168015d32f890ca15812c9180835d2e",
|
|
"type" : "IDENTITY",
|
|
"email" : "alison.ferguso@identitysoon.com"
|
|
},
|
|
"maxReminders" : 1,
|
|
"daysUntilEscalation" : 0,
|
|
"daysBetweenReminders" : 0
|
|
},
|
|
"autoApprovalEnabled" : true,
|
|
"entitlementRequestConfig" : {
|
|
"requestCommentsRequired" : false,
|
|
"deniedCommentsRequired" : false,
|
|
"allowEntitlementRequest" : true,
|
|
"grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584"
|
|
},
|
|
"reauthorizationEnabled" : true,
|
|
"approvalsMustBeExternal" : true
|
|
}
|
|
"@
|
|
|
|
# Update Access Request Configuration
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig
|
|
Set-AccessRequestConfig-AccessRequestConfig $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Set-AccessRequestConfig -AccessRequestConfig $AccessRequestConfig
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-AccessRequestConfig"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/access-request-status:
|
|
get:
|
|
operationId: listAccessRequestStatus
|
|
security:
|
|
- userAuth:
|
|
- idn:access-request-status:read
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
tags:
|
|
- Access Requests
|
|
summary: Access Request Status
|
|
description: |-
|
|
Use this API to return a list of access request statuses based on the specified query parameters.
|
|
If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses.
|
|
Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users.
|
|
parameters:
|
|
- in: query
|
|
name: requested-for
|
|
schema:
|
|
type: string
|
|
example: 2c9180877b2b6ea4017b2c545f971429
|
|
description: Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*.
|
|
required: false
|
|
- in: query
|
|
name: requested-by
|
|
schema:
|
|
type: string
|
|
example: 2c9180877b2b6ea4017b2c545f971429
|
|
description: Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*.
|
|
required: false
|
|
- in: query
|
|
name: regarding-identity
|
|
schema:
|
|
type: string
|
|
example: 2c9180877b2b6ea4017b2c545f971429
|
|
description: Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*.
|
|
required: false
|
|
- in: query
|
|
name: assigned-to
|
|
schema:
|
|
type: string
|
|
example: 2c9180877b2b6ea4017b2c545f971429
|
|
description: Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user.
|
|
required: false
|
|
- in: query
|
|
name: count
|
|
description: If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored.
|
|
required: false
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
example: false
|
|
- in: query
|
|
name: limit
|
|
description: Max number of results to return.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
format: int32
|
|
minimum: 0
|
|
maximum: 250
|
|
default: 250
|
|
example: 100
|
|
- in: query
|
|
name: offset
|
|
description: Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
format: int32
|
|
minimum: 0
|
|
example: 10
|
|
- in: query
|
|
name: filters
|
|
schema:
|
|
type: string
|
|
example: accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"
|
|
description: |-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
**accessRequestId**: *in*
|
|
|
|
**accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw*
|
|
|
|
**created**: *eq, in, ge, gt, le, lt, ne, isnull, sw*
|
|
required: false
|
|
- in: query
|
|
name: sorters
|
|
schema:
|
|
type: string
|
|
format: comma-separated
|
|
description: |-
|
|
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
|
|
|
Sorting is supported for the following fields: **created, modified, accountActivityItemId, name**
|
|
example: created
|
|
required: false
|
|
- in: query
|
|
name: request-state
|
|
schema:
|
|
type: string
|
|
example: request-state=EXECUTING
|
|
description: Filter the results by the state of the request. The only valid value is *EXECUTING*.
|
|
required: false
|
|
responses:
|
|
'200':
|
|
description: List of requested item statuses.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Human-readable display name of the item being requested.
|
|
example: AccessProfile1
|
|
nullable: true
|
|
type:
|
|
type: string
|
|
enum:
|
|
- ACCESS_PROFILE
|
|
- ROLE
|
|
- ENTITLEMENT
|
|
- null
|
|
description: Type of requested object.
|
|
example: ACCESS_PROFILE
|
|
nullable: true
|
|
cancelledRequestDetails:
|
|
allOf:
|
|
- type: object
|
|
properties:
|
|
comment:
|
|
type: string
|
|
description: Comment made by the owner when cancelling the associated request.
|
|
example: This request must be cancelled.
|
|
owner:
|
|
$ref: '#/components/schemas/ServiceDeskIntegrationDto/allOf/0/properties/ownerRef/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/OwnerDto.yaml
|
|
modified:
|
|
type: string
|
|
format: date-time
|
|
description: Date comment was added by the owner when cancelling the associated request.
|
|
example: '2019-12-20T09:17:12.192Z'
|
|
description: Provides additional details for a request that has been cancelled.
|
|
- nullable: true
|
|
errorMessages:
|
|
type: array
|
|
nullable: true
|
|
items:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/400/content/application~1json/schema/properties/messages/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ErrorMessageDto.yaml
|
|
description: List of list of localized error messages, if any, encountered during the approval/provisioning process.
|
|
state:
|
|
type: string
|
|
enum:
|
|
- EXECUTING
|
|
- REQUEST_COMPLETED
|
|
- CANCELLED
|
|
- TERMINATED
|
|
- PROVISIONING_VERIFICATION_PENDING
|
|
- REJECTED
|
|
- PROVISIONING_FAILED
|
|
- NOT_ALL_ITEMS_PROVISIONED
|
|
- ERROR
|
|
description: |-
|
|
Indicates the state of an access request:
|
|
* EXECUTING: The request is executing, which indicates the system is doing some processing.
|
|
* REQUEST_COMPLETED: Indicates the request has been completed.
|
|
* CANCELLED: The request was cancelled with no user input.
|
|
* TERMINATED: The request has been terminated before it was able to complete.
|
|
* PROVISIONING_VERIFICATION_PENDING: The request has finished any approval steps and provisioning is waiting to be verified.
|
|
* REJECTED: The request was rejected.
|
|
* PROVISIONING_FAILED: The request has failed to complete.
|
|
* NOT_ALL_ITEMS_PROVISIONED: One or more of the requested items failed to complete, but there were one or more successes.
|
|
* ERROR: An error occurred during request processing.
|
|
example: EXECUTING
|
|
approvalDetails:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
approvalId:
|
|
type: string
|
|
description: Unique identifier for the approval.
|
|
example: 2c9180877b2b6ea4017b2c545f971429
|
|
nullable: true
|
|
forwarded:
|
|
type: boolean
|
|
default: false
|
|
description: True if the request for this item was forwarded from one owner to another.
|
|
example: false
|
|
originalOwner:
|
|
type: object
|
|
description: Identity of orginal approval owner.
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: DTO type of original approval owner's identity.
|
|
enum:
|
|
- GOVERNANCE_GROUP
|
|
- IDENTITY
|
|
example: IDENTITY
|
|
id:
|
|
type: string
|
|
description: ID of original approval owner's identity.
|
|
example: 2c7180a46faadee4016fb4e018c20642
|
|
name:
|
|
type: string
|
|
description: Display name of original approval owner.
|
|
example: Michael Michaels
|
|
currentOwner:
|
|
allOf:
|
|
- $ref: '#/paths/~1access-request-approvals~1completed/get/responses/200/content/application~1json/schema/items/properties/reviewedBy'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/AccessItemReviewedBy.yaml
|
|
- nullable: true
|
|
modified:
|
|
type: string
|
|
format: date-time
|
|
description: Time at which item was modified.
|
|
example: '2019-08-23T18:52:57.398Z'
|
|
nullable: true
|
|
status:
|
|
type: string
|
|
enum:
|
|
- PENDING
|
|
- APPROVED
|
|
- REJECTED
|
|
- EXPIRED
|
|
- CANCELLED
|
|
- ARCHIVED
|
|
description: |-
|
|
Indicates the state of the request processing for this item:
|
|
* PENDING: The request for this item is awaiting processing.
|
|
* APPROVED: The request for this item has been approved.
|
|
* REJECTED: The request for this item was rejected.
|
|
* EXPIRED: The request for this item expired with no action taken.
|
|
* CANCELLED: The request for this item was cancelled with no user action.
|
|
* ARCHIVED: The request for this item has been archived after completion.
|
|
example: PENDING
|
|
scheme:
|
|
type: string
|
|
enum:
|
|
- APP_OWNER
|
|
- SOURCE_OWNER
|
|
- MANAGER
|
|
- ROLE_OWNER
|
|
- ACCESS_PROFILE_OWNER
|
|
- ENTITLEMENT_OWNER
|
|
- GOVERNANCE_GROUP
|
|
description: Describes the individual or group that is responsible for an approval step.
|
|
example: MANAGER
|
|
errorMessages:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/400/content/application~1json/schema/properties/messages/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ErrorMessageDto.yaml
|
|
description: If the request failed, includes any error messages that were generated.
|
|
nullable: true
|
|
comment:
|
|
type: string
|
|
description: Comment, if any, provided by the approver.
|
|
example: I approve this request
|
|
nullable: true
|
|
removeDate:
|
|
type: string
|
|
description: The date the role or access profile or entitlement is no longer assigned to the specified identity.
|
|
format: date-time
|
|
example: '2020-07-11T00:00:00Z'
|
|
nullable: true
|
|
description: Approval details for each item.
|
|
approvalIds:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: List of approval IDs associated with the request.
|
|
example:
|
|
- 85f0cf482dd44327b593624c07906c21
|
|
- fa57e1bfa36f41ee85e33ee59fcbeac5
|
|
nullable: true
|
|
manualWorkItemDetails:
|
|
type: array
|
|
nullable: true
|
|
items:
|
|
type: object
|
|
properties:
|
|
forwarded:
|
|
type: boolean
|
|
default: false
|
|
description: True if the request for this item was forwarded from one owner to another.
|
|
example: true
|
|
originalOwner:
|
|
type: object
|
|
nullable: true
|
|
description: Identity of original work item owner, if the work item has been forwarded.
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: DTO type of original work item owner's identity.
|
|
enum:
|
|
- GOVERNANCE_GROUP
|
|
- IDENTITY
|
|
example: IDENTITY
|
|
id:
|
|
type: string
|
|
description: ID of original work item owner's identity.
|
|
example: 2c7180a46faadee4016fb4e018c20642
|
|
name:
|
|
type: string
|
|
description: Display name of original work item owner.
|
|
example: Michael Michaels
|
|
currentOwner:
|
|
type: object
|
|
description: Identity of current work item owner.
|
|
nullable: true
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: DTO type of current work item owner's identity.
|
|
enum:
|
|
- GOVERNANCE_GROUP
|
|
- IDENTITY
|
|
example: IDENTITY
|
|
id:
|
|
type: string
|
|
description: ID of current work item owner's identity.
|
|
example: 2c3780a46faadee4016fb4e018c20652
|
|
name:
|
|
type: string
|
|
description: Display name of current work item owner.
|
|
example: Allen Albertson
|
|
modified:
|
|
type: string
|
|
format: date-time
|
|
description: Time at which item was modified.
|
|
example: '2019-08-23T18:52:57.398Z'
|
|
status:
|
|
$ref: '#/paths/~1access-request-status/get/responses/200/content/application~1json/schema/items/properties/approvalDetails/items/properties/status'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ManualWorkItemState.yaml
|
|
forwardHistory:
|
|
type: array
|
|
nullable: true
|
|
items:
|
|
$ref: '#/paths/~1access-request-approvals~1pending/get/responses/200/content/application~1json/schema/items/properties/forwardHistory/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ApprovalForwardHistory.yaml
|
|
description: The history of approval forward action.
|
|
description: Manual work items created for provisioning the item.
|
|
accountActivityItemId:
|
|
type: string
|
|
description: Id of associated account activity item.
|
|
example: 2c9180926cbfbddd016cbfc7c3b10010
|
|
requestType:
|
|
$ref: '#/components/schemas/AccessRequest/properties/requestType'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/AccessRequestType.yaml
|
|
modified:
|
|
type: string
|
|
format: date-time
|
|
description: When the request was last modified.
|
|
example: '2019-08-23T18:52:59.162Z'
|
|
nullable: true
|
|
created:
|
|
type: string
|
|
format: date-time
|
|
description: When the request was created.
|
|
example: '2019-08-23T18:40:35.772Z'
|
|
requester:
|
|
type: object
|
|
description: Access item requester's identity.
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: Access item requester's DTO type.
|
|
enum:
|
|
- IDENTITY
|
|
example: IDENTITY
|
|
id:
|
|
type: string
|
|
description: Access item requester's identity ID.
|
|
example: 2c7180a46faadee4016fb4e018c20648
|
|
name:
|
|
type: string
|
|
description: Access item owner's human-readable display name.
|
|
example: William Wilson
|
|
requestedFor:
|
|
type: object
|
|
description: Identity access was requested for.
|
|
properties:
|
|
type:
|
|
type: string
|
|
enum:
|
|
- IDENTITY
|
|
description: Type of the object to which this reference applies
|
|
example: IDENTITY
|
|
id:
|
|
type: string
|
|
description: ID of the object to which this reference applies
|
|
example: 2c9180835d191a86015d28455b4b232a
|
|
name:
|
|
type: string
|
|
description: Human-readable display name of the object to which this reference applies
|
|
example: William Wilson
|
|
requesterComment:
|
|
allOf:
|
|
- $ref: '#/paths/~1access-request-approvals~1%7BapprovalId%7D~1approve/post/requestBody/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/CommentDto.yaml
|
|
- nullable: true
|
|
description: The requester's comment.
|
|
sodViolationContext:
|
|
allOf:
|
|
- description: An object referencing a completed SOD violation check
|
|
type: object
|
|
nullable: true
|
|
properties:
|
|
state:
|
|
type: string
|
|
enum:
|
|
- SUCCESS
|
|
- ERROR
|
|
- null
|
|
description: The status of SOD violation check
|
|
example: SUCCESS
|
|
nullable: true
|
|
uuid:
|
|
description: The id of the Violation check event
|
|
type: string
|
|
example: f73d16e9-a038-46c5-b217-1246e15fdbdd
|
|
nullable: true
|
|
violationCheckResult:
|
|
description: The inner object representing the completed SOD Violation check
|
|
type: object
|
|
properties:
|
|
message:
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/400/content/application~1json/schema/properties/messages/items'
|
|
description: If the request failed, this includes any error message that was generated.
|
|
example:
|
|
- locale: en-US
|
|
localeOrigin: DEFAULT
|
|
text: An error has occurred during the SOD violation check
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ErrorMessageDto.yaml
|
|
clientMetadata:
|
|
type: object
|
|
nullable: true
|
|
additionalProperties:
|
|
type: string
|
|
description: Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check.
|
|
example:
|
|
requestedAppName: test-app
|
|
requestedAppId: 2c91808f7892918f0178b78da4a305a1
|
|
violationContexts:
|
|
type: array
|
|
nullable: true
|
|
items:
|
|
description: The contextual information of the violated criteria
|
|
type: object
|
|
properties:
|
|
policy:
|
|
$ref: '#/paths/~1access-request-status/get/responses/200/content/application~1json/schema/items/properties/sodViolationContext/allOf/0/properties/violationCheckResult/properties/violatedPolicies/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/SodPolicyDto.yaml
|
|
conflictingAccessCriteria:
|
|
type: object
|
|
description: The object which contains the left and right hand side of the entitlements that got violated according to the policy.
|
|
properties:
|
|
leftCriteria:
|
|
type: object
|
|
properties:
|
|
criteriaList:
|
|
type: array
|
|
items:
|
|
description: Details of the Entitlement criteria
|
|
type: object
|
|
properties:
|
|
existing:
|
|
type: boolean
|
|
default: false
|
|
example: true
|
|
description: If the entitlement already belonged to the user or not.
|
|
type:
|
|
$ref: '#/components/schemas/AccessProfileSummary/allOf/0/allOf/1/properties/type'
|
|
example: ENTITLEMENT
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/DtoType.yaml
|
|
id:
|
|
type: string
|
|
description: Entitlement ID
|
|
example: 2c918085771e9d3301773b3cb66f6398
|
|
name:
|
|
type: string
|
|
description: Entitlement name
|
|
example: My HR Entitlement
|
|
rightCriteria:
|
|
type: object
|
|
properties:
|
|
criteriaList:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1access-request-status/get/responses/200/content/application~1json/schema/items/properties/sodViolationContext/allOf/0/properties/violationCheckResult/properties/violationContexts/items/properties/conflictingAccessCriteria/properties/leftCriteria/properties/criteriaList/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/SodExemptCriteria.yaml
|
|
violatedPolicies:
|
|
type: array
|
|
nullable: true
|
|
description: A list of the SOD policies that were violated.
|
|
items:
|
|
type: object
|
|
description: SOD policy.
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: SOD policy DTO type.
|
|
enum:
|
|
- SOD_POLICY
|
|
example: SOD_POLICY
|
|
id:
|
|
type: string
|
|
description: SOD policy ID.
|
|
example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde
|
|
name:
|
|
type: string
|
|
description: SOD policy display name.
|
|
example: Business SOD Policy
|
|
- nullable: true
|
|
description: The details of the SOD violations for the associated approval.
|
|
provisioningDetails:
|
|
allOf:
|
|
- type: object
|
|
properties:
|
|
orderedSubPhaseReferences:
|
|
type: string
|
|
description: Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain "manualWorkItemDetails" which indicate that there is further information in that object for this phase.
|
|
example: manualWorkItemDetails
|
|
description: Provides additional details about provisioning for this request.
|
|
- nullable: true
|
|
preApprovalTriggerDetails:
|
|
allOf:
|
|
- type: object
|
|
properties:
|
|
comment:
|
|
type: string
|
|
description: Comment left for the pre-approval decision
|
|
example: Access is Approved
|
|
reviewer:
|
|
type: string
|
|
description: The reviewer of the pre-approval decision
|
|
example: John Doe
|
|
decision:
|
|
type: string
|
|
enum:
|
|
- APPROVED
|
|
- REJECTED
|
|
description: The decision of the pre-approval trigger
|
|
example: APPROVED
|
|
description: Provides additional details about the pre-approval trigger for this request.
|
|
- nullable: true
|
|
accessRequestPhases:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
started:
|
|
type: string
|
|
description: The time that this phase started.
|
|
format: date-time
|
|
example: '2020-07-11T00:00:00Z'
|
|
finished:
|
|
type: string
|
|
description: The time that this phase finished.
|
|
format: date-time
|
|
example: '2020-07-12T00:00:00Z'
|
|
nullable: true
|
|
name:
|
|
type: string
|
|
description: The name of this phase.
|
|
example: APPROVAL_PHASE
|
|
state:
|
|
type: string
|
|
enum:
|
|
- PENDING
|
|
- EXECUTING
|
|
- COMPLETED
|
|
- CANCELLED
|
|
- NOT_EXECUTED
|
|
description: The state of this phase.
|
|
example: COMPLETED
|
|
result:
|
|
type: string
|
|
enum:
|
|
- SUCCESSFUL
|
|
- FAILED
|
|
- null
|
|
description: The state of this phase.
|
|
example: SUCCESSFUL
|
|
nullable: true
|
|
phaseReference:
|
|
type: string
|
|
description: A reference to another object on the RequestedItemStatus that contains more details about the phase. Note that for the Provisioning phase, this will be empty if there are no manual work items.
|
|
example: approvalDetails
|
|
nullable: true
|
|
description: Provides additional details about this access request phase.
|
|
description: A list of Phases that the Access Request has gone through in order, to help determine the status of the request.
|
|
nullable: true
|
|
description:
|
|
type: string
|
|
description: Description associated to the requested object.
|
|
example: This is the Engineering role that engineers are granted.
|
|
nullable: true
|
|
removeDate:
|
|
type: string
|
|
format: date-time
|
|
nullable: true
|
|
description: When the role access is scheduled for removal.
|
|
example: '2019-10-23T00:00:00.000Z'
|
|
cancelable:
|
|
type: boolean
|
|
default: false
|
|
description: True if the request can be canceled.
|
|
example: true
|
|
accessRequestId:
|
|
type: string
|
|
description: This is the account activity id.
|
|
example: 2b838de9-db9b-abcf-e646-d4f274ad4238
|
|
clientMetadata:
|
|
nullable: true
|
|
type: object
|
|
additionalProperties:
|
|
type: string
|
|
description: Arbitrary key-value pairs, if any were included in the corresponding access request
|
|
example:
|
|
key1: value1
|
|
key2: value2
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$RequestedFor = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional)
|
|
$RequestedBy = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional)
|
|
$RegardingIdentity = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional)
|
|
$AssignedTo = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional)
|
|
$Count = $false # Boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to $false)
|
|
$Limit = 100 # Int32 | Max number of results to return. (optional) (default to 250)
|
|
$Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional)
|
|
$Filters = "accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional)
|
|
$Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name** (optional)
|
|
$RequestState = "request-state=EXECUTING" # String | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional)
|
|
|
|
# Access Request Status
|
|
|
|
try {
|
|
Get-AccessRequestStatus
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-AccessRequestStatus -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -AssignedTo $AssignedTo -Count $Count -Limit $Limit -Offset $Offset -Filters $Filters -Sorters $Sorters -RequestState $RequestState
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessRequestStatus"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/access-request-approvals/pending:
|
|
get:
|
|
operationId: listPendingApprovals
|
|
summary: Pending Access Request Approvals List
|
|
tags:
|
|
- Access Request Approvals
|
|
description: This endpoint returns a list of pending approvals. See "owner-id" query parameter below for authorization info.
|
|
parameters:
|
|
- in: query
|
|
name: owner-id
|
|
schema:
|
|
type: string
|
|
description: |-
|
|
If present, the value returns only pending approvals for the specified identity.
|
|
* ORG_ADMIN users can call this with any identity ID value.
|
|
* ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used.
|
|
* Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value.
|
|
example: 2c91808568c529c60168cca6f90c1313
|
|
required: false
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
- in: query
|
|
name: filters
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: |-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
**id**: *eq, in*
|
|
|
|
**requestedFor.id**: *eq, in*
|
|
|
|
**modified**: *gt, lt, ge, le, eq, in*
|
|
example: id eq "2c91808568c529c60168cca6f90c1313"
|
|
- in: query
|
|
name: sorters
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: comma-separated
|
|
description: |-
|
|
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
|
|
|
Sorting is supported for the following fields: **created, modified**
|
|
example: modified
|
|
responses:
|
|
'200':
|
|
description: List of Pending Approvals.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The approval id.
|
|
example: id12345
|
|
name:
|
|
type: string
|
|
description: The name of the approval.
|
|
example: aName
|
|
created:
|
|
type: string
|
|
format: date-time
|
|
description: When the approval was created.
|
|
example: '2017-07-11T18:45:37.098Z'
|
|
modified:
|
|
type: string
|
|
format: date-time
|
|
description: When the approval was modified last time.
|
|
example: '2018-07-25T20:22:28.104Z'
|
|
requestCreated:
|
|
type: string
|
|
format: date-time
|
|
description: When the access-request was created.
|
|
example: '2017-07-11T18:45:35.098Z'
|
|
requestType:
|
|
$ref: '#/components/schemas/AccessRequest/properties/requestType'
|
|
description: If the access-request was for granting or revoking access.
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/AccessRequestType.yaml
|
|
requester:
|
|
$ref: '#/paths/~1access-request-status/get/responses/200/content/application~1json/schema/items/properties/requester'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/AccessItemRequester.yaml
|
|
requestedFor:
|
|
type: array
|
|
description: Identities access was requested for.
|
|
items:
|
|
type: object
|
|
description: Identity the access item is requested for.
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: DTO type of identity the access item is requested for.
|
|
enum:
|
|
- IDENTITY
|
|
example: IDENTITY
|
|
id:
|
|
type: string
|
|
description: ID of identity the access item is requested for.
|
|
example: 2c4180a46faadee4016fb4e018c20626
|
|
name:
|
|
type: string
|
|
description: Human-readable display name of identity the access item is requested for.
|
|
example: Robert Robinson
|
|
minItems: 1
|
|
maxItems: 10
|
|
owner:
|
|
type: object
|
|
description: Access item owner's identity.
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: Access item owner's DTO type.
|
|
enum:
|
|
- IDENTITY
|
|
example: IDENTITY
|
|
id:
|
|
type: string
|
|
description: Access item owner's identity ID.
|
|
example: 2c9180a46faadee4016fb4e018c20639
|
|
name:
|
|
type: string
|
|
description: Access item owner's human-readable display name.
|
|
example: Support
|
|
requestedObject:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: Id of the object.
|
|
example: 2c9180835d2e5168015d32f890ca1581
|
|
name:
|
|
type: string
|
|
description: Name of the object.
|
|
example: Applied Research Access
|
|
description:
|
|
type: string
|
|
description: Description of the object.
|
|
example: Access to research information, lab results, and schematics
|
|
type:
|
|
type: string
|
|
enum:
|
|
- ACCESS_PROFILE
|
|
- ROLE
|
|
- ENTITLEMENT
|
|
description: Type of the object.
|
|
example: ROLE
|
|
requesterComment:
|
|
$ref: '#/paths/~1access-request-approvals~1%7BapprovalId%7D~1approve/post/requestBody/content/application~1json/schema'
|
|
description: The requester's comment.
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/CommentDto.yaml
|
|
previousReviewersComments:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1access-request-approvals~1%7BapprovalId%7D~1approve/post/requestBody/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/CommentDto.yaml
|
|
description: The history of the previous reviewers comments.
|
|
forwardHistory:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
oldApproverName:
|
|
type: string
|
|
description: Display name of approver from whom the approval was forwarded.
|
|
example: Frank Mir
|
|
newApproverName:
|
|
type: string
|
|
description: Display name of approver to whom the approval was forwarded.
|
|
example: Al Volta
|
|
comment:
|
|
type: string
|
|
nullable: true
|
|
description: Comment made while forwarding.
|
|
example: Forwarding from Frank to Al
|
|
modified:
|
|
type: string
|
|
format: date-time
|
|
description: Time at which approval was forwarded.
|
|
example: '2019-08-23T18:52:57.398Z'
|
|
forwarderName:
|
|
type: string
|
|
nullable: true
|
|
description: Display name of forwarder who forwarded the approval.
|
|
example: William Wilson
|
|
reassignmentType:
|
|
type: string
|
|
enum:
|
|
- MANUAL_REASSIGNMENT
|
|
- AUTOMATIC_REASSIGNMENT
|
|
- AUTO_ESCALATION
|
|
- SELF_REVIEW_DELEGATION
|
|
description: |-
|
|
The approval reassignment type.
|
|
* MANUAL_REASSIGNMENT: An approval with this reassignment type has been specifically reassigned by the approval task's owner, from their queue to someone else's.
|
|
* AUTOMATIC_REASSIGNMENT: An approval with this reassignment type has been automatically reassigned from another approver's queue, according to that approver's reassignment configuration. The approver's reassignment configuration may be set up to automatically reassign approval tasks for a defined (or possibly open-ended) period of time.
|
|
* AUTO_ESCALATION: An approval with this reassignment type has been automatically reassigned from another approver's queue, according to the request's escalation configuration. For more information about escalation configuration, refer to [Setting Global Reminders and Escalation Policies](https://documentation.sailpoint.com/saas/help/requests/config_emails.html).
|
|
* SELF_REVIEW_DELEGATION: An approval with this reassignment type has been automatically reassigned by the system to prevent self-review. This helps prevent situations like a requester being tasked with approving their own request. For more information about preventing self-review, refer to [Self-review Prevention](https://documentation.sailpoint.com/saas/help/users/work_reassignment.html#self-review-prevention) and [Preventing Self-approval](https://documentation.sailpoint.com/saas/help/requests/config_ap_roles.html#preventing-self-approval).
|
|
example: AUTOMATIC_REASSIGNMENT
|
|
description: The history of approval forward action.
|
|
commentRequiredWhenRejected:
|
|
type: boolean
|
|
default: false
|
|
description: When true the rejector has to provide comments when rejecting
|
|
example: true
|
|
actionInProcess:
|
|
type: string
|
|
enum:
|
|
- APPROVED
|
|
- REJECTED
|
|
- FORWARDED
|
|
description: Enum represents action that is being processed on an approval.
|
|
example: APPROVED
|
|
removeDate:
|
|
type: string
|
|
description: The date the role or access profile or entitlement is no longer assigned to the specified identity.
|
|
format: date-time
|
|
example: '2020-07-11T00:00:00Z'
|
|
removeDateUpdateRequested:
|
|
type: boolean
|
|
default: false
|
|
description: If true, then the request is to change the remove date or sunset date.
|
|
example: true
|
|
currentRemoveDate:
|
|
type: string
|
|
description: The remove date or sunset date that was assigned at the time of the request.
|
|
format: date-time
|
|
example: '2020-07-11T00:00:00Z'
|
|
sodViolationContext:
|
|
$ref: '#/paths/~1access-request-status/get/responses/200/content/application~1json/schema/items/properties/sodViolationContext/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/SodViolationContextCheckCompleted.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$OwnerId = "2c91808568c529c60168cca6f90c1313" # String | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional)
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
$Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* (optional)
|
|
$Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional)
|
|
|
|
# Pending Access Request Approvals List
|
|
|
|
try {
|
|
Get-PendingApprovals
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-PendingApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PendingApprovals"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/access-request-approvals/completed:
|
|
get:
|
|
operationId: listCompletedApprovals
|
|
summary: Completed Access Request Approvals List
|
|
tags:
|
|
- Access Request Approvals
|
|
description: This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info.
|
|
parameters:
|
|
- in: query
|
|
name: owner-id
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: |-
|
|
If present, the value returns only completed approvals for the specified identity.
|
|
* ORG_ADMIN users can call this with any identity ID value.
|
|
* ORG_ADMIN users can also fetch all the approvals in the org, when
|
|
owner-id is not used.
|
|
* Non-ORG_ADMIN users can only specify *me* or pass their own
|
|
identity ID value.
|
|
example: 2c91808568c529c60168cca6f90c1313
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
- in: query
|
|
name: filters
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: |-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
**id**: *eq, in, ge, gt, le, lt, ne, isnull, sw*
|
|
|
|
**requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw*
|
|
|
|
**modified**: *gt, lt, ge, le, eq, in, ne, sw*
|
|
example: id eq "2c91808568c529c60168cca6f90c1313"
|
|
- in: query
|
|
name: sorters
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: comma-separated
|
|
description: |-
|
|
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
|
|
|
Sorting is supported for the following fields: **created, modified**
|
|
example: modified
|
|
responses:
|
|
'200':
|
|
description: List of Completed Approvals.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The approval id.
|
|
example: id12345
|
|
name:
|
|
type: string
|
|
description: The name of the approval.
|
|
example: aName
|
|
created:
|
|
type: string
|
|
format: date-time
|
|
description: When the approval was created.
|
|
example: '2017-07-11T18:45:37.098Z'
|
|
modified:
|
|
type: string
|
|
format: date-time
|
|
description: When the approval was modified last time.
|
|
example: '2018-07-25T20:22:28.104Z'
|
|
requestCreated:
|
|
type: string
|
|
format: date-time
|
|
description: When the access-request was created.
|
|
example: '2017-07-11T18:45:35.098Z'
|
|
requestType:
|
|
$ref: '#/components/schemas/AccessRequest/properties/requestType'
|
|
description: If the access-request was for granting or revoking access.
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/AccessRequestType.yaml
|
|
requester:
|
|
$ref: '#/paths/~1access-request-status/get/responses/200/content/application~1json/schema/items/properties/requester'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/AccessItemRequester.yaml
|
|
requestedFor:
|
|
type: object
|
|
description: Identity access was requested for.
|
|
properties:
|
|
type:
|
|
type: string
|
|
enum:
|
|
- IDENTITY
|
|
description: Type of the object to which this reference applies
|
|
example: IDENTITY
|
|
id:
|
|
type: string
|
|
description: ID of the object to which this reference applies
|
|
example: 2c9180835d191a86015d28455b4b232a
|
|
name:
|
|
type: string
|
|
description: Human-readable display name of the object to which this reference applies
|
|
example: William Wilson
|
|
reviewedBy:
|
|
type: object
|
|
description: Identity who reviewed the access item request.
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: DTO type of identity who reviewed the access item request.
|
|
enum:
|
|
- IDENTITY
|
|
example: IDENTITY
|
|
id:
|
|
type: string
|
|
description: ID of identity who reviewed the access item request.
|
|
example: 2c3780a46faadee4016fb4e018c20652
|
|
name:
|
|
type: string
|
|
description: Human-readable display name of identity who reviewed the access item request.
|
|
example: Allen Albertson
|
|
owner:
|
|
$ref: '#/components/schemas/ServiceDeskIntegrationDto/allOf/0/properties/ownerRef/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/OwnerDto.yaml
|
|
requestedObject:
|
|
$ref: '#/paths/~1access-request-approvals~1pending/get/responses/200/content/application~1json/schema/items/properties/requestedObject'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/RequestableObjectReference.yaml
|
|
requesterComment:
|
|
allOf:
|
|
- $ref: '#/paths/~1access-request-approvals~1%7BapprovalId%7D~1approve/post/requestBody/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/CommentDto.yaml
|
|
- description: The requester's comment.
|
|
reviewerComment:
|
|
allOf:
|
|
- $ref: '#/paths/~1access-request-approvals~1%7BapprovalId%7D~1approve/post/requestBody/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/CommentDto.yaml
|
|
- description: The approval's reviewer's comment.
|
|
nullable: true
|
|
previousReviewersComments:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1access-request-approvals~1%7BapprovalId%7D~1approve/post/requestBody/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/CommentDto.yaml
|
|
description: The history of the previous reviewers comments.
|
|
forwardHistory:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1access-request-approvals~1pending/get/responses/200/content/application~1json/schema/items/properties/forwardHistory/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ApprovalForwardHistory.yaml
|
|
description: The history of approval forward action.
|
|
commentRequiredWhenRejected:
|
|
type: boolean
|
|
default: false
|
|
description: When true the rejector has to provide comments when rejecting
|
|
example: true
|
|
state:
|
|
type: string
|
|
enum:
|
|
- APPROVED
|
|
- REJECTED
|
|
description: Enum represents completed approval object's state.
|
|
example: APPROVED
|
|
removeDate:
|
|
type: string
|
|
description: The date the role or access profile or entitlement is no longer assigned to the specified identity.
|
|
format: date-time
|
|
example: '2020-07-11T00:00:00Z'
|
|
nullable: true
|
|
removeDateUpdateRequested:
|
|
type: boolean
|
|
default: false
|
|
description: If true, then the request was to change the remove date or sunset date.
|
|
example: true
|
|
currentRemoveDate:
|
|
type: string
|
|
description: The remove date or sunset date that was assigned at the time of the request.
|
|
format: date-time
|
|
example: '2020-07-11T00:00:00Z'
|
|
nullable: true
|
|
sodViolationContext:
|
|
$ref: '#/paths/~1access-request-status/get/responses/200/content/application~1json/schema/items/properties/sodViolationContext/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/SodViolationContextCheckCompleted.yaml
|
|
preApprovalTriggerResult:
|
|
nullable: true
|
|
type: object
|
|
description: If the access request submitted event trigger is configured and this access request was intercepted by it, then this is the result of the trigger's decision to either approve or deny the request.
|
|
properties:
|
|
comment:
|
|
type: string
|
|
description: The comment from the trigger
|
|
example: This request was autoapproved by our automated ETS subscriber
|
|
decision:
|
|
$ref: '#/paths/~1access-request-approvals~1completed/get/responses/200/content/application~1json/schema/items/properties/state'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/CompletedApprovalState.yaml
|
|
reviewer:
|
|
type: string
|
|
description: The name of the approver
|
|
example: Automated AR Approval
|
|
date:
|
|
type: string
|
|
format: date-time
|
|
example: '2022-06-07T19:18:40.748Z'
|
|
description: The date and time the trigger decided on the request
|
|
clientMetadata:
|
|
type: object
|
|
additionalProperties:
|
|
type: string
|
|
description: Arbitrary key-value pairs provided during the request.
|
|
example:
|
|
requestedAppName: test-app
|
|
requestedAppId: 2c91808f7892918f0178b78da4a305a1
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$OwnerId = "2c91808568c529c60168cca6f90c1313" # String | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional)
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
$Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional)
|
|
$Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional)
|
|
|
|
# Completed Access Request Approvals List
|
|
|
|
try {
|
|
Get-CompletedApprovals
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-CompletedApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CompletedApprovals"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/access-request-approvals/{approvalId}/approve:
|
|
post:
|
|
operationId: approveAccessRequest
|
|
security:
|
|
- userAuth:
|
|
- idn:access-request-approvals:read
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- APPROVAL_OWNER
|
|
summary: Approve Access Request Approval
|
|
tags:
|
|
- Access Request Approvals
|
|
description: Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action.
|
|
parameters:
|
|
- in: path
|
|
name: approvalId
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listPendingApprovals
|
|
description: Approval ID.
|
|
example: 2c91808b7294bea301729568c68c002e
|
|
requestBody:
|
|
description: Reviewer's comment.
|
|
required: false
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
comment:
|
|
type: string
|
|
nullable: true
|
|
description: Comment content.
|
|
example: This is a comment.
|
|
created:
|
|
type: string
|
|
format: date-time
|
|
description: Date and time comment was created.
|
|
example: '2017-07-11T18:45:37.098Z'
|
|
author:
|
|
type: object
|
|
readOnly: true
|
|
description: Author of the comment
|
|
properties:
|
|
type:
|
|
type: string
|
|
enum:
|
|
- IDENTITY
|
|
example: IDENTITY
|
|
description: The type of object
|
|
id:
|
|
type: string
|
|
description: The unique ID of the object
|
|
example: 2c9180847e25f377017e2ae8cae4650b
|
|
name:
|
|
type: string
|
|
description: The display name of the object
|
|
example: john.doe
|
|
responses:
|
|
'202':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/202'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/202.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID.
|
|
$CommentDto = @"
|
|
{
|
|
"created" : "2017-07-11T18:45:37.098Z",
|
|
"author" : {
|
|
"name" : "john.doe",
|
|
"id" : "2c9180847e25f377017e2ae8cae4650b",
|
|
"type" : "IDENTITY"
|
|
},
|
|
"comment" : "This is a comment."
|
|
}
|
|
"@
|
|
|
|
# Approve Access Request Approval
|
|
|
|
try {
|
|
Approve-AccessRequest-ApprovalId $ApprovalId
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Approve-AccessRequest -ApprovalId $ApprovalId -CommentDto $CommentDto
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-AccessRequest"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/access-request-approvals/{approvalId}/reject:
|
|
post:
|
|
operationId: rejectAccessRequest
|
|
summary: Reject Access Request Approval
|
|
tags:
|
|
- Access Request Approvals
|
|
description: Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action.
|
|
parameters:
|
|
- in: path
|
|
name: approvalId
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listPendingApprovals
|
|
description: Approval ID.
|
|
example: 2c91808b7294bea301729568c68c002e
|
|
requestBody:
|
|
description: Reviewer's comment.
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1access-request-approvals~1%7BapprovalId%7D~1approve/post/requestBody/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/CommentDto.yaml
|
|
responses:
|
|
'202':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/202'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/202.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID.
|
|
$CommentDto = @"
|
|
{
|
|
"created" : "2017-07-11T18:45:37.098Z",
|
|
"author" : {
|
|
"name" : "john.doe",
|
|
"id" : "2c9180847e25f377017e2ae8cae4650b",
|
|
"type" : "IDENTITY"
|
|
},
|
|
"comment" : "This is a comment."
|
|
}
|
|
"@
|
|
|
|
# Reject Access Request Approval
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToCommentDto -Json $CommentDto
|
|
Deny-AccessRequest-ApprovalId $ApprovalId -CommentDto $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Deny-AccessRequest -ApprovalId $ApprovalId -CommentDto $CommentDto
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-AccessRequest"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/access-request-approvals/{approvalId}/forward:
|
|
post:
|
|
operationId: forwardAccessRequest
|
|
summary: Forward Access Request Approval
|
|
tags:
|
|
- Access Request Approvals
|
|
description: Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action.
|
|
parameters:
|
|
- in: path
|
|
name: approvalId
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listPendingApprovals
|
|
description: Approval ID.
|
|
example: 2c91808b7294bea301729568c68c002e
|
|
requestBody:
|
|
description: Information about the forwarded approval.
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
required:
|
|
- newOwnerId
|
|
- comment
|
|
properties:
|
|
newOwnerId:
|
|
type: string
|
|
description: The Id of the new owner
|
|
example: 2c91808568c529c60168cca6f90c1314
|
|
minLength: 1
|
|
maxLength: 255
|
|
comment:
|
|
type: string
|
|
description: The comment provided by the forwarder
|
|
example: 2c91808568c529c60168cca6f90c1313
|
|
minLength: 1
|
|
maxLength: 255
|
|
responses:
|
|
'202':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/202'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/202.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID.
|
|
$ForwardApprovalDto = @"
|
|
{
|
|
"newOwnerId" : "2c91808568c529c60168cca6f90c1314",
|
|
"comment" : "2c91808568c529c60168cca6f90c1313"
|
|
}
|
|
"@
|
|
|
|
# Forward Access Request Approval
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto
|
|
Invoke-ForwardAccessRequest-ApprovalId $ApprovalId -ForwardApprovalDto $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Invoke-ForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $ForwardApprovalDto
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-ForwardAccessRequest"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/access-request-approvals/approval-summary:
|
|
get:
|
|
operationId: getAccessRequestApprovalSummary
|
|
security:
|
|
- userAuth:
|
|
- idn:access-request-approvals-summary:read
|
|
summary: Get Access Requests Approvals Number
|
|
tags:
|
|
- Access Request Approvals
|
|
description: Use this API to return the number of pending, approved and rejected access requests approvals. See the "owner-id" query parameter for authorization information. info.
|
|
parameters:
|
|
- in: query
|
|
name: owner-id
|
|
schema:
|
|
type: string
|
|
description: |-
|
|
The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity.
|
|
* ORG_ADMIN users can call this with any identity ID value.
|
|
* ORG_ADMIN user can also fetch all the approvals in the org, when
|
|
owner-id is not used.
|
|
* Non ORG_ADMIN users can only specify *me* or pass their own
|
|
identity ID value.
|
|
example: 2c91808568c529c60168cca6f90c1313
|
|
required: false
|
|
- in: query
|
|
name: from-date
|
|
schema:
|
|
type: string
|
|
description: This is the date and time the results will be shown from. It must be in a valid ISO-8601 format.
|
|
example: from-date=2020-03-19T19:59:11Z
|
|
required: false
|
|
responses:
|
|
'200':
|
|
description: Number of pending, approved, rejected access request approvals.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
pending:
|
|
type: integer
|
|
description: The number of pending access requests approvals.
|
|
format: int32
|
|
example: 0
|
|
approved:
|
|
type: integer
|
|
description: The number of approved access requests approvals.
|
|
format: int32
|
|
example: 0
|
|
rejected:
|
|
type: integer
|
|
description: The number of rejected access requests approvals.
|
|
format: int32
|
|
example: 0
|
|
'400':
|
|
description: Client Error - Returned if the query parameter is invalid.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/400/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ErrorResponseDto.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$OwnerId = "2c91808568c529c60168cca6f90c1313" # String | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional)
|
|
$FromDate = "from-date=2020-03-19T19:59:11Z" # String | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional)
|
|
|
|
# Get Access Requests Approvals Number
|
|
|
|
try {
|
|
Get-AccessRequestApprovalSummary
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-AccessRequestApprovalSummary -OwnerId $OwnerId -FromDate $FromDate
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessRequestApprovalSummary"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/accounts:
|
|
get:
|
|
operationId: listAccounts
|
|
tags:
|
|
- Accounts
|
|
summary: Accounts List
|
|
description: 'List accounts. '
|
|
security:
|
|
- userAuth:
|
|
- idn:accounts:read
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- SOURCE_ADMIN
|
|
- SOURCE_SUBADMIN
|
|
- HELPDESK
|
|
parameters:
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
- in: query
|
|
name: detailLevel
|
|
schema:
|
|
type: string
|
|
enum:
|
|
- SLIM
|
|
- FULL
|
|
description: This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior.
|
|
example: FULL
|
|
- in: query
|
|
name: filters
|
|
schema:
|
|
type: string
|
|
example: identityId eq "2c9180858082150f0180893dbaf44201"
|
|
description: |-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
**id**: *eq, in, sw*
|
|
|
|
**identityId**: *eq, in, sw*
|
|
|
|
**name**: *eq, in, sw*
|
|
|
|
**nativeIdentity**: *eq, in, sw*
|
|
|
|
**sourceId**: *eq, in, sw*
|
|
|
|
**uncorrelated**: *eq*
|
|
|
|
**entitlements**: *eq*
|
|
|
|
**origin**: *eq, in*
|
|
|
|
**manuallyCorrelated**: *eq*
|
|
|
|
**identity.name**: *eq, in, sw*
|
|
|
|
**identity.correlated**: *eq*
|
|
|
|
**identity.identityState**: *eq, in*
|
|
|
|
**source.displayableName**: *eq, in*
|
|
|
|
**source.authoritative**: *eq*
|
|
|
|
**source.connectionType**: *eq, in*
|
|
|
|
**recommendation.method**: *eq, in, isnull*
|
|
required: false
|
|
- in: query
|
|
name: sorters
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: comma-separated
|
|
example: id,name
|
|
description: |-
|
|
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
|
|
|
Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType**
|
|
responses:
|
|
'200':
|
|
description: List of account objects.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
allOf:
|
|
- $ref: '#/components/schemas/Account/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/BaseCommonDto.yaml
|
|
- type: object
|
|
required:
|
|
- sourceId
|
|
- sourceName
|
|
- attributes
|
|
- authoritative
|
|
- disabled
|
|
- locked
|
|
- nativeIdentity
|
|
- systemAccount
|
|
- uncorrelated
|
|
- manuallyCorrelated
|
|
- hasEntitlements
|
|
properties:
|
|
sourceId:
|
|
type: string
|
|
example: 2c9180835d2e5168015d32f890ca1581
|
|
description: The unique ID of the source this account belongs to
|
|
sourceName:
|
|
type: string
|
|
nullable: true
|
|
example: Employees
|
|
description: The display name of the source this account belongs to
|
|
identityId:
|
|
type: string
|
|
example: 2c9180835d2e5168015d32f890ca1581
|
|
description: The unique ID of the identity this account is correlated to
|
|
cloudLifecycleState:
|
|
type: string
|
|
nullable: true
|
|
example: active
|
|
description: The lifecycle state of the identity this account is correlated to
|
|
identityState:
|
|
type: string
|
|
nullable: true
|
|
example: ACTIVE
|
|
description: The identity state of the identity this account is correlated to
|
|
connectionType:
|
|
type: string
|
|
nullable: true
|
|
example: direct
|
|
description: The connection type of the source this account is from
|
|
isMachine:
|
|
type: boolean
|
|
default: false
|
|
description: Indicates if the account is of machine type
|
|
example: true
|
|
recommendation:
|
|
$ref: '#/components/schemas/Account/allOf/1/properties/recommendation'
|
|
nullable: true
|
|
description: Indicates that the account is currently classified to be one type but is recommended to be a different one
|
|
example:
|
|
type: MACHINE
|
|
method: DISCOVERY
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/Recommendation.yaml
|
|
attributes:
|
|
type: object
|
|
nullable: true
|
|
additionalProperties: true
|
|
description: The account attributes that are aggregated
|
|
example:
|
|
firstName: SailPoint
|
|
lastName: Support
|
|
displayName: SailPoint Support
|
|
authoritative:
|
|
type: boolean
|
|
description: Indicates if this account is from an authoritative source
|
|
example: false
|
|
description:
|
|
type: string
|
|
description: A description of the account
|
|
nullable: true
|
|
example: null
|
|
disabled:
|
|
type: boolean
|
|
description: Indicates if the account is currently disabled
|
|
example: false
|
|
locked:
|
|
type: boolean
|
|
description: Indicates if the account is currently locked
|
|
example: false
|
|
nativeIdentity:
|
|
type: string
|
|
description: The unique ID of the account generated by the source system
|
|
example: '552775'
|
|
systemAccount:
|
|
type: boolean
|
|
example: false
|
|
description: If true, this is a user account within IdentityNow. If false, this is an account from a source system.
|
|
uncorrelated:
|
|
type: boolean
|
|
description: Indicates if this account is not correlated to an identity
|
|
example: false
|
|
uuid:
|
|
type: string
|
|
description: The unique ID of the account as determined by the account schema
|
|
example: '{b0dce506-d6d4-44d2-8a32-d9a5b21fb175}'
|
|
nullable: true
|
|
manuallyCorrelated:
|
|
type: boolean
|
|
description: Indicates if the account has been manually correlated to an identity
|
|
example: false
|
|
hasEntitlements:
|
|
type: boolean
|
|
description: Indicates if the account has entitlements
|
|
example: true
|
|
identity:
|
|
$ref: '#/components/schemas/Account/allOf/1/properties/identity'
|
|
description: The identity this account is correlated to
|
|
example:
|
|
id: 2c918084660f45d6016617daa9210584
|
|
type: IDENTITY
|
|
name: Adam Kennedy
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/BaseReferenceDto.yaml
|
|
sourceOwner:
|
|
$ref: '#/components/schemas/Account/allOf/1/properties/identity'
|
|
nullable: true
|
|
description: The owner of the source this account belongs to.
|
|
example:
|
|
id: 2c918084660f45d6016617daa9210584
|
|
type: IDENTITY
|
|
name: Adam Kennedy
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/BaseReferenceDto.yaml
|
|
features:
|
|
type: string
|
|
description: A string list containing the owning source's features
|
|
example: ENABLE
|
|
nullable: true
|
|
origin:
|
|
type: string
|
|
nullable: true
|
|
enum:
|
|
- AGGREGATED
|
|
- PROVISIONED
|
|
- null
|
|
description: The origin of the account either aggregated or provisioned
|
|
example: AGGREGATED
|
|
ownerIdentity:
|
|
$ref: '#/components/schemas/Account/allOf/1/properties/identity'
|
|
description: The identity who owns this account, used only for machine accounts
|
|
nullable: true
|
|
example:
|
|
id: 2c918084660f45d6016617daa9210584
|
|
type: IDENTITY
|
|
name: Adam Kennedy
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/BaseReferenceDto.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
$DetailLevel = "SLIM" # String | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional)
|
|
$Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* (optional)
|
|
$Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional)
|
|
|
|
# Accounts List
|
|
|
|
try {
|
|
Get-Accounts
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-Accounts -Limit $Limit -Offset $Offset -Count $Count -DetailLevel $DetailLevel -Filters $Filters -Sorters $Sorters
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Accounts"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
post:
|
|
operationId: createAccount
|
|
tags:
|
|
- Accounts
|
|
summary: Create Account
|
|
description: |
|
|
Submit an account creation task - the API then returns the task ID.
|
|
|
|
You must include the `sourceId` where the account will be created in the `attributes` object.
|
|
|
|
This endpoint creates an account on the source record in your ISC tenant.
|
|
This is useful for Flat File (`DelimitedFile`) type sources because it allows you to aggregate new accounts without needing to import a new CSV file every time.
|
|
|
|
However, if you use this endpoint to create an account for a Direct Connection type source, you must ensure that the account also exists on the target source.
|
|
The endpoint doesn't actually provision the account on the target source, which means that if the account doesn't also exist on the target source, an aggregation between the source and your tenant will remove it from your tenant.
|
|
|
|
By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account.
|
|
security:
|
|
- userAuth:
|
|
- idn:accounts:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- SOURCE_ADMIN
|
|
- SOURCE_SUBADMIN
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
required:
|
|
- attributes
|
|
properties:
|
|
attributes:
|
|
description: The schema attribute values for the account
|
|
type: object
|
|
required:
|
|
- sourceId
|
|
properties:
|
|
sourceId:
|
|
type: string
|
|
description: Target source to create an account
|
|
example: 34bfcbe116c9407464af37acbaf7a4dc
|
|
additionalProperties:
|
|
type: string
|
|
example:
|
|
sourceId: 34bfcbe116c9407464af37acbaf7a4dc
|
|
city: Austin
|
|
displayName: John Doe
|
|
userName: jdoe
|
|
sAMAccountName: jDoe
|
|
mail: john.doe@sailpoint.com
|
|
responses:
|
|
'202':
|
|
description: Async task details.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
description: Accounts async response containing details on started async process
|
|
required:
|
|
- id
|
|
type: object
|
|
properties:
|
|
id:
|
|
description: id of the task
|
|
type: string
|
|
example: 2c91808474683da6017468693c260195
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$AccountAttributesCreate = @"
|
|
{
|
|
"attributes" : {
|
|
"sourceId" : "34bfcbe116c9407464af37acbaf7a4dc",
|
|
"city" : "Austin",
|
|
"displayName" : "John Doe",
|
|
"userName" : "jdoe",
|
|
"sAMAccountName" : "jDoe",
|
|
"mail" : "john.doe@sailpoint.com"
|
|
}
|
|
}
|
|
"@
|
|
|
|
# Create Account
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate
|
|
New-Account-AccountAttributesCreate $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# New-Account -AccountAttributesCreate $AccountAttributesCreate
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Account"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/accounts/{id}:
|
|
get:
|
|
operationId: getAccount
|
|
tags:
|
|
- Accounts
|
|
summary: Account Details
|
|
description: 'Use this API to return the details for a single account by its ID. '
|
|
security:
|
|
- userAuth:
|
|
- idn:accounts:read
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- SOURCE_ADMIN
|
|
- SOURCE_SUBADMIN
|
|
- HELPDESK
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listAccounts
|
|
description: Account ID.
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
responses:
|
|
'200':
|
|
description: Account object.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1accounts/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/Account.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID.
|
|
|
|
# Account Details
|
|
|
|
try {
|
|
Get-Account-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-Account -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Account"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
patch:
|
|
operationId: updateAccount
|
|
tags:
|
|
- Accounts
|
|
summary: Update Account
|
|
description: |
|
|
Use this API to update account details.
|
|
|
|
This API supports updating an account's correlation by modifying the `identityId` and `manuallyCorrelated` fields.
|
|
To reassign an account from one identity to another, replace the current `identityId` with a new value.
|
|
If the account you're assigning was provisioned by Identity Security Cloud (ISC), it's possible for ISC to create a new account
|
|
for the previous identity as soon as the account is moved. If the account you're assigning is authoritative,
|
|
this causes the previous identity to become uncorrelated and can even result in its deletion.
|
|
All accounts that are reassigned will be set to `manuallyCorrelated: true` unless you specify otherwise.
|
|
|
|
>**Note:** The `attributes` field can only be modified for flat file accounts.
|
|
security:
|
|
- userAuth:
|
|
- idn:accounts:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- SOURCE_ADMIN
|
|
- SOURCE_SUBADMIN
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listAccounts
|
|
description: Account ID.
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
requestBody:
|
|
required: true
|
|
description: A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
content:
|
|
application/json-patch+json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
examples:
|
|
Uncorrelate account:
|
|
description: Remove account from Identity
|
|
value:
|
|
- op: remove
|
|
path: /identityId
|
|
Reassign account:
|
|
description: Move account from one Identity to another Identity
|
|
value:
|
|
- op: replace
|
|
path: /identityId
|
|
value: 2c9180857725c14301772a93bb77242d
|
|
Add account attribute:
|
|
description: Add flat file account's attribute
|
|
value:
|
|
- op: add
|
|
path: /attributes/familyName
|
|
value: Smith
|
|
Replace account attribute:
|
|
description: Replace flat file account's attribute
|
|
value:
|
|
- op: replace
|
|
path: /attributes/familyName
|
|
value: Smith
|
|
Remove account attribute:
|
|
description: Remove flat file account's attribute
|
|
value:
|
|
- op: remove
|
|
path: /attributes/familyName
|
|
responses:
|
|
'202':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/202'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/202.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID.
|
|
$RequestBody = # SystemCollectionsHashtable[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
$RequestBody = @"[{op=remove, path=/identityId}]"@
|
|
|
|
|
|
# Update Account
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
|
|
Update-Account-Id $Id -RequestBody $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Update-Account -Id $Id -RequestBody $RequestBody
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Account"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
put:
|
|
operationId: putAccount
|
|
tags:
|
|
- Accounts
|
|
summary: Update Account
|
|
description: |
|
|
Use this API to update an account with a PUT request.
|
|
|
|
This endpoint submits an account update task and returns the task ID.
|
|
|
|
>**Note: You can only use this PUT endpoint to update accounts from flat file sources.**
|
|
security:
|
|
- userAuth:
|
|
- idn:accounts:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- SOURCE_ADMIN
|
|
- SOURCE_SUBADMIN
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listAccounts
|
|
description: Account ID.
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
required:
|
|
- attributes
|
|
properties:
|
|
attributes:
|
|
description: The schema attribute values for the account
|
|
type: object
|
|
additionalProperties: true
|
|
example:
|
|
city: Austin
|
|
displayName: John Doe
|
|
userName: jdoe
|
|
sAMAccountName: jDoe
|
|
mail: john.doe@sailpoint.com
|
|
responses:
|
|
'202':
|
|
description: Async task details.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1accounts/post/responses/202/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/AccountsAsyncResult.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID.
|
|
$AccountAttributes = @"
|
|
{
|
|
"attributes" : {
|
|
"city" : "Austin",
|
|
"displayName" : "John Doe",
|
|
"userName" : "jdoe",
|
|
"sAMAccountName" : "jDoe",
|
|
"mail" : "john.doe@sailpoint.com"
|
|
}
|
|
}
|
|
"@
|
|
|
|
# Update Account
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes
|
|
Send-Account-Id $Id -AccountAttributes $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Send-Account -Id $Id -AccountAttributes $AccountAttributes
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-Account"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
delete:
|
|
operationId: deleteAccount
|
|
tags:
|
|
- Accounts
|
|
summary: Delete Account
|
|
description: |-
|
|
Use this API to delete an account.
|
|
This endpoint submits an account delete task and returns the task ID.
|
|
This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account's returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future.
|
|
>**NOTE: You can only delete accounts from sources of the "DelimitedFile" type.**
|
|
security:
|
|
- userAuth:
|
|
- idn:accounts:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- SOURCE_ADMIN
|
|
- SOURCE_SUBADMIN
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listAccounts
|
|
description: Account ID.
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
responses:
|
|
'202':
|
|
description: Async task details.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1accounts/post/responses/202/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/AccountsAsyncResult.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID.
|
|
|
|
# Delete Account
|
|
|
|
try {
|
|
Remove-Account-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Remove-Account -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Account"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/accounts/{id}/entitlements:
|
|
get:
|
|
operationId: getAccountEntitlements
|
|
tags:
|
|
- Accounts
|
|
summary: Account Entitlements
|
|
description: 'This API returns entitlements of the account. '
|
|
security:
|
|
- userAuth:
|
|
- idn:accounts:read
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- SOURCE_ADMIN
|
|
- SOURCE_SUBADMIN
|
|
- HELPDESK
|
|
parameters:
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listAccounts
|
|
description: The account id
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
responses:
|
|
'200':
|
|
description: An array of account entitlements
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
allOf:
|
|
- $ref: '#/components/schemas/Account/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/BaseCommonDto.yaml
|
|
- type: object
|
|
description: Entitlement object that represents entitlement
|
|
properties:
|
|
attribute:
|
|
description: Name of the entitlement attribute
|
|
type: string
|
|
example: authorizationType
|
|
value:
|
|
description: Raw value of the entitlement
|
|
type: string
|
|
example: CN=Users,dc=sailpoint,dc=com
|
|
description:
|
|
description: Entitlment description
|
|
type: string
|
|
example: Active Directory DC
|
|
attributes:
|
|
description: Entitlement attributes
|
|
type: object
|
|
additionalProperties: true
|
|
example:
|
|
GroupType: Security
|
|
sAMAccountName: Buyer
|
|
sourceSchemaObjectType:
|
|
description: Schema objectType on the given application that maps to an Account Group
|
|
type: string
|
|
example: group
|
|
privileged:
|
|
description: Determines if this Entitlement is privileged.
|
|
type: boolean
|
|
example: false
|
|
cloudGoverned:
|
|
description: Determines if this Entitlement is goverened in the cloud.
|
|
type: boolean
|
|
example: false
|
|
source:
|
|
type: object
|
|
description: Source the entitlement belongs to.
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: DTO type of source the entitlement belongs to.
|
|
enum:
|
|
- SOURCE
|
|
example: SOURCE
|
|
id:
|
|
type: string
|
|
description: ID of source the entitlement belongs to.
|
|
example: 2c9180835d191a86015d28455b4b232a
|
|
name:
|
|
type: string
|
|
description: Human-readable name of source the entitlement belongs to.
|
|
example: HR Active Directory
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
|
|
# Account Entitlements
|
|
|
|
try {
|
|
Get-AccountEntitlements-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-AccountEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $Count
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccountEntitlements"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/accounts/{id}/reload:
|
|
post:
|
|
operationId: submitReloadAccount
|
|
tags:
|
|
- Accounts
|
|
summary: Reload Account
|
|
description: 'This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. '
|
|
security:
|
|
- userAuth:
|
|
- idn:accounts-state:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- SOURCE_ADMIN
|
|
- SOURCE_SUBADMIN
|
|
- HELPDESK
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listAccounts
|
|
description: The account id
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
responses:
|
|
'202':
|
|
description: Async task details
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1accounts/post/responses/202/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/AccountsAsyncResult.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id
|
|
|
|
# Reload Account
|
|
|
|
try {
|
|
Submit-ReloadAccount-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Submit-ReloadAccount -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-ReloadAccount"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/accounts/{id}/enable:
|
|
post:
|
|
operationId: enableAccount
|
|
tags:
|
|
- Accounts
|
|
summary: Enable Account
|
|
description: 'This API submits a task to enable account and returns the task ID. '
|
|
security:
|
|
- userAuth:
|
|
- idn:accounts-state:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- SOURCE_ADMIN
|
|
- SOURCE_SUBADMIN
|
|
- HELPDESK
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listAccounts
|
|
description: The account id
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
description: Request used for account enable/disable
|
|
type: object
|
|
properties:
|
|
externalVerificationId:
|
|
description: If set, an external process validates that the user wants to proceed with this request.
|
|
type: string
|
|
example: 3f9180835d2e5168015d32f890ca1581
|
|
forceProvisioning:
|
|
description: If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. Providing 'true' for an unlocked account will add and process 'Unlock' operation by the workflow.
|
|
type: boolean
|
|
example: false
|
|
responses:
|
|
'202':
|
|
description: Async task details
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1accounts/post/responses/202/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/AccountsAsyncResult.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id
|
|
$AccountToggleRequest = @"
|
|
{
|
|
"forceProvisioning" : false,
|
|
"externalVerificationId" : "3f9180835d2e5168015d32f890ca1581"
|
|
}
|
|
"@
|
|
|
|
# Enable Account
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest
|
|
Enable-Account-Id $Id -AccountToggleRequest $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Enable-Account -Id $Id -AccountToggleRequest $AccountToggleRequest
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-Account"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/accounts/{id}/disable:
|
|
post:
|
|
operationId: disableAccount
|
|
tags:
|
|
- Accounts
|
|
summary: Disable Account
|
|
description: 'This API submits a task to disable the account and returns the task ID. '
|
|
security:
|
|
- userAuth:
|
|
- idn:accounts-state:manage
|
|
x-sailpont-userLevels:
|
|
- ORG_ADMIN
|
|
- SOURCE_ADMIN
|
|
- SOURCE_SUBADMIN
|
|
- HELPDESK
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listAccounts
|
|
description: The account id
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1accounts~1%7Bid%7D~1enable/post/requestBody/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/AccountToggleRequest.yaml
|
|
responses:
|
|
'202':
|
|
description: Async task details
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1accounts/post/responses/202/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/AccountsAsyncResult.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id
|
|
$AccountToggleRequest = @"
|
|
{
|
|
"forceProvisioning" : false,
|
|
"externalVerificationId" : "3f9180835d2e5168015d32f890ca1581"
|
|
}
|
|
"@
|
|
|
|
# Disable Account
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest
|
|
Disable-Account-Id $Id -AccountToggleRequest $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Disable-Account -Id $Id -AccountToggleRequest $AccountToggleRequest
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-Account"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/accounts/{id}/unlock:
|
|
post:
|
|
operationId: unlockAccount
|
|
tags:
|
|
- Accounts
|
|
summary: Unlock Account
|
|
description: |-
|
|
This API submits a task to unlock an account and returns the task ID.
|
|
To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required.
|
|
security:
|
|
- userAuth:
|
|
- idn:accounts-state:manage
|
|
- idn:accounts-provisioning:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- SOURCE_ADMIN
|
|
- SOURCE_SUBADMIN
|
|
- HELPDESK
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listAccounts
|
|
description: The account ID.
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
description: Request used for account unlock
|
|
type: object
|
|
properties:
|
|
externalVerificationId:
|
|
description: If set, an external process validates that the user wants to proceed with this request.
|
|
type: string
|
|
example: 3f9180835d2e5168015d32f890ca1581
|
|
unlockIDNAccount:
|
|
description: If set, the IDN account is unlocked after the workflow completes.
|
|
type: boolean
|
|
example: false
|
|
forceProvisioning:
|
|
description: If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated.
|
|
type: boolean
|
|
example: false
|
|
responses:
|
|
'202':
|
|
description: Async task details
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1accounts/post/responses/202/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/AccountsAsyncResult.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID.
|
|
$AccountUnlockRequest = @"
|
|
{
|
|
"forceProvisioning" : false,
|
|
"externalVerificationId" : "3f9180835d2e5168015d32f890ca1581",
|
|
"unlockIDNAccount" : false
|
|
}
|
|
"@
|
|
|
|
# Unlock Account
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest
|
|
Unlock-Account-Id $Id -AccountUnlockRequest $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Unlock-Account -Id $Id -AccountUnlockRequest $AccountUnlockRequest
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Unlock-Account"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/accounts/search-attribute-config:
|
|
post:
|
|
operationId: createSearchAttributeConfig
|
|
security:
|
|
- userAuth:
|
|
- idn:account-config:create
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
tags:
|
|
- Search Attribute Configuration
|
|
summary: Create Extended Search Attributes
|
|
description: Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create and attribute promotion configuration in the Link ObjectConfig.
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Name of the new attribute
|
|
example: newMailAttribute
|
|
displayName:
|
|
type: string
|
|
description: The display name of the new attribute
|
|
example: New Mail Attribute
|
|
applicationAttributes:
|
|
type: object
|
|
description: Map of application id and their associated attribute.
|
|
example:
|
|
2c91808b79fd2422017a0b35d30f3968: employeeNumber
|
|
2c91808b79fd2422017a0b36008f396b: employeeNumber
|
|
example:
|
|
name: newMailAttribute
|
|
displayName: New Mail Attribute
|
|
applicationAttributes:
|
|
2c9180866166b5b0016167c32ef31a66: mail
|
|
2c9180866166b5b0016167c32ef31a67: mail
|
|
responses:
|
|
'202':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/202'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/202.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$SearchAttributeConfig = @"
|
|
{
|
|
"displayName" : "New Mail Attribute",
|
|
"name" : "newMailAttribute",
|
|
"applicationAttributes" : {
|
|
"2c91808b79fd2422017a0b35d30f3968" : "employeeNumber",
|
|
"2c91808b79fd2422017a0b36008f396b" : "employeeNumber"
|
|
}
|
|
}
|
|
"@
|
|
|
|
# Create Extended Search Attributes
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig
|
|
New-SearchAttributeConfig-SearchAttributeConfig $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# New-SearchAttributeConfig -SearchAttributeConfig $SearchAttributeConfig
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SearchAttributeConfig"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
get:
|
|
operationId: getSearchAttributeConfig
|
|
security:
|
|
- userAuth:
|
|
- idn:account-config:read
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
tags:
|
|
- Search Attribute Configuration
|
|
summary: List Extended Search Attributes
|
|
description: Get a list of attribute/application associates currently configured in Identity Security Cloud (ISC).
|
|
responses:
|
|
'200':
|
|
description: List of attribute configurations in IdentityNow.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1accounts~1search-attribute-config/post/requestBody/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/SearchAttributeConfig.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
|
|
# List Extended Search Attributes
|
|
|
|
try {
|
|
Get-SearchAttributeConfig
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-SearchAttributeConfig
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SearchAttributeConfig"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/accounts/search-attribute-config/{name}:
|
|
get:
|
|
operationId: getSingleSearchAttributeConfig
|
|
security:
|
|
- userAuth:
|
|
- idn:account-config:read
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
tags:
|
|
- Search Attribute Configuration
|
|
summary: Get Extended Search Attribute
|
|
description: Get an extended attribute configuration by name.
|
|
parameters:
|
|
- name: name
|
|
in: path
|
|
description: Name of the extended search attribute configuration to retrieve.
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getSearchAttributeConfig
|
|
schema:
|
|
type: string
|
|
example: newMailAttribute
|
|
responses:
|
|
'200':
|
|
description: Specific attribute configuration in ISC.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1accounts~1search-attribute-config/post/requestBody/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/SearchAttributeConfig.yaml
|
|
'204':
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/204.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Name = "newMailAttribute" # String | Name of the extended search attribute configuration to retrieve.
|
|
|
|
# Get Extended Search Attribute
|
|
|
|
try {
|
|
Get-SingleSearchAttributeConfig-Name $Name
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-SingleSearchAttributeConfig -Name $Name
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SingleSearchAttributeConfig"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
delete:
|
|
operationId: deleteSearchAttributeConfig
|
|
security:
|
|
- userAuth:
|
|
- idn:account-config:delete
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
tags:
|
|
- Search Attribute Configuration
|
|
summary: Delete Extended Search Attribute
|
|
description: Delete an extended attribute configuration by name.
|
|
parameters:
|
|
- name: name
|
|
in: path
|
|
description: Name of the extended search attribute configuration to delete.
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getSearchAttributeConfig
|
|
schema:
|
|
type: string
|
|
example: newMailAttribute
|
|
responses:
|
|
'204':
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/204.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete.
|
|
|
|
# Delete Extended Search Attribute
|
|
|
|
try {
|
|
Remove-SearchAttributeConfig-Name $Name
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Remove-SearchAttributeConfig -Name $Name
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SearchAttributeConfig"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
patch:
|
|
operationId: patchSearchAttributeConfig
|
|
security:
|
|
- userAuth:
|
|
- idn:account-config:create
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
tags:
|
|
- Search Attribute Configuration
|
|
summary: Update Extended Search Attribute
|
|
description: |-
|
|
Update an existing search attribute configuration.
|
|
You can patch these fields:
|
|
* name * displayName * applicationAttributes
|
|
parameters:
|
|
- name: name
|
|
in: path
|
|
description: Name of the search attribute configuration to patch.
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getSearchAttributeConfig
|
|
schema:
|
|
type: string
|
|
example: promotedMailAttribute
|
|
requestBody:
|
|
content:
|
|
application/json-patch+json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/JsonPatchOperation.yaml
|
|
example:
|
|
- op: replace
|
|
path: /name
|
|
value: newAttributeName
|
|
- op: replace
|
|
path: /displayName
|
|
value: new attribute display name
|
|
- op: add
|
|
path: /applicationAttributes
|
|
value:
|
|
2c91808b79fd2422017a0b35d30f3968: employeeNumber
|
|
required: true
|
|
responses:
|
|
'200':
|
|
description: The updated search attribute configuration.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1accounts~1search-attribute-config/post/requestBody/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/SearchAttributeConfig.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Name = "promotedMailAttribute" # String | Name of the search attribute configuration to patch.
|
|
# JsonPatchOperation[] |
|
|
$JsonPatchOperation = @"{
|
|
"op" : "replace",
|
|
"path" : "/description",
|
|
"value" : "New description"
|
|
}"@
|
|
|
|
|
|
# Update Extended Search Attribute
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
|
|
Update-SearchAttributeConfig-Name $Name -JsonPatchOperation $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Update-SearchAttributeConfig -Name $Name -JsonPatchOperation $JsonPatchOperation
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SearchAttributeConfig"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/account-activities:
|
|
get:
|
|
operationId: listAccountActivities
|
|
tags:
|
|
- Account Activities
|
|
summary: List Account Activities
|
|
description: This gets a collection of account activities that satisfy the given query parameters.
|
|
parameters:
|
|
- in: query
|
|
name: requested-for
|
|
schema:
|
|
type: string
|
|
description: The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*.
|
|
required: false
|
|
example: 2c91808568c529c60168cca6f90c1313
|
|
- in: query
|
|
name: requested-by
|
|
schema:
|
|
type: string
|
|
description: The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*.
|
|
required: false
|
|
example: 2c91808568c529c60168cca6f90c1313
|
|
- in: query
|
|
name: regarding-identity
|
|
schema:
|
|
type: string
|
|
description: The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*.
|
|
required: false
|
|
example: 2c91808568c529c60168cca6f90c1313
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
- in: query
|
|
name: filters
|
|
schema:
|
|
type: string
|
|
description: |-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
**type**: *eq, in, ge, le, lt, ne, isnull, sw*
|
|
|
|
**created**: *gt, lt, ge, le, eq, in, ne, isnull, sw*
|
|
|
|
**modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw*
|
|
example: type eq "Identity Refresh"
|
|
required: false
|
|
- in: query
|
|
name: sorters
|
|
schema:
|
|
type: string
|
|
format: comma-separated
|
|
description: |-
|
|
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
|
|
|
Sorting is supported for the following fields: **type, created, modified**
|
|
example: created
|
|
required: false
|
|
responses:
|
|
'200':
|
|
description: List of account activities
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: Id of the account activity
|
|
example: 2c9180835d2e5168015d32f890ca1581
|
|
name:
|
|
type: string
|
|
description: The name of the activity
|
|
example: 2c9180835d2e5168015d32f890ca1581
|
|
created:
|
|
description: When the activity was first created
|
|
type: string
|
|
format: date-time
|
|
example: '2017-07-11T18:45:37.098Z'
|
|
modified:
|
|
description: When the activity was last modified
|
|
type: string
|
|
format: date-time
|
|
example: '2018-06-25T20:22:28.104Z'
|
|
nullable: true
|
|
completed:
|
|
description: When the activity was completed
|
|
type: string
|
|
format: date-time
|
|
nullable: true
|
|
example: '2018-10-19T13:49:37.385Z'
|
|
completionStatus:
|
|
$ref: '#/components/schemas/AccountActivity/properties/completionStatus'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/CompletionStatus.yaml
|
|
type:
|
|
nullable: true
|
|
type: string
|
|
example: appRequest
|
|
description: |
|
|
The type of action the activity performed. Please see the following list of types. This list may grow over time.
|
|
|
|
- CloudAutomated
|
|
- IdentityAttributeUpdate
|
|
- appRequest
|
|
- LifecycleStateChange
|
|
- AccountStateUpdate
|
|
- AccountAttributeUpdate
|
|
- CloudPasswordRequest
|
|
- Attribute Synchronization Refresh
|
|
- Certification
|
|
- Identity Refresh
|
|
- Lifecycle Change Refresh
|
|
|
|
|
|
[Learn more here](https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data).
|
|
requesterIdentitySummary:
|
|
$ref: '#/components/schemas/AccountActivity/properties/requesterIdentitySummary'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/IdentitySummary.yaml
|
|
targetIdentitySummary:
|
|
$ref: '#/components/schemas/AccountActivity/properties/requesterIdentitySummary'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/IdentitySummary.yaml
|
|
errors:
|
|
nullable: true
|
|
description: A list of error messages, if any, that were encountered.
|
|
type: array
|
|
items:
|
|
type: string
|
|
example:
|
|
- 'sailpoint.connector.ConnectorException: java.lang.InterruptedException: Timeout waiting for response to message 0 from client 57a4ab97-ab3f-4aef-9fe2-0eaf15c73d26 after 60 seconds.'
|
|
warnings:
|
|
nullable: true
|
|
description: A list of warning messages, if any, that were encountered.
|
|
type: array
|
|
items:
|
|
type: string
|
|
example:
|
|
- Some warning, another warning
|
|
items:
|
|
nullable: true
|
|
type: array
|
|
description: Individual actions performed as part of this account activity
|
|
items:
|
|
$ref: '#/components/schemas/AccountActivity/properties/items/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/AccountActivityItem.yaml
|
|
executionStatus:
|
|
$ref: '#/components/schemas/AccountActivity/properties/executionStatus'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ExecutionStatus.yaml
|
|
clientMetadata:
|
|
nullable: true
|
|
type: object
|
|
additionalProperties:
|
|
type: string
|
|
description: Arbitrary key-value pairs, if any were included in the corresponding access request
|
|
example:
|
|
customKey1: custom value 1
|
|
customKey2: custom value 2
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$RequestedFor = "2c91808568c529c60168cca6f90c1313" # String | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional)
|
|
$RequestedBy = "2c91808568c529c60168cca6f90c1313" # String | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional)
|
|
$RegardingIdentity = "2c91808568c529c60168cca6f90c1313" # String | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional)
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
$Filters = "type eq "Identity Refresh"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional)
|
|
$Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** (optional)
|
|
|
|
# List Account Activities
|
|
|
|
try {
|
|
Get-AccountActivities
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-AccountActivities -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccountActivities"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/account-activities/{id}:
|
|
get:
|
|
operationId: getAccountActivity
|
|
tags:
|
|
- Account Activities
|
|
summary: Get an Account Activity
|
|
description: This gets a single account activity by its id.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listAccountActivities
|
|
description: The account activity id
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
responses:
|
|
'200':
|
|
description: An account activity object
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1account-activities/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/AccountActivity.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account activity id
|
|
|
|
# Get an Account Activity
|
|
|
|
try {
|
|
Get-AccountActivity-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-AccountActivity -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccountActivity"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/auth-org/network-config:
|
|
get:
|
|
operationId: getAuthOrgNetworkConfig
|
|
tags:
|
|
- Global Tenant Security Settings
|
|
summary: Get security network configuration.
|
|
description: This API returns the details of an org's network auth configuration.
|
|
security:
|
|
- userAuth:
|
|
- sp:auth-org:read
|
|
responses:
|
|
'200':
|
|
description: Network configuration for the tenant's auth org.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
range:
|
|
type: array
|
|
description: The collection of ip ranges.
|
|
items:
|
|
type: string
|
|
example:
|
|
- 1.3.7.2
|
|
- 255.255.255.252/30
|
|
nullable: true
|
|
geolocation:
|
|
type: array
|
|
description: The collection of country codes.
|
|
items:
|
|
type: string
|
|
example:
|
|
- CA
|
|
- FR
|
|
- HT
|
|
nullable: true
|
|
whitelisted:
|
|
type: boolean
|
|
description: Denotes whether the provided lists are whitelisted or blacklisted for geo location.
|
|
default: false
|
|
example: true
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
|
|
# Get security network configuration.
|
|
|
|
try {
|
|
Get-AuthOrgNetworkConfig
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-AuthOrgNetworkConfig
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AuthOrgNetworkConfig"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
post:
|
|
operationId: createAuthOrgNetworkConfig
|
|
tags:
|
|
- Global Tenant Security Settings
|
|
summary: Create security network configuration.
|
|
description: 'This API returns the details of an org''s network auth configuration. Requires security scope of: ''sp:auth-org:manage'''
|
|
security:
|
|
- userAuth:
|
|
- sp:auth-org:manage
|
|
requestBody:
|
|
required: true
|
|
description: |-
|
|
Network configuration creation request body. The following constraints ensure the request body conforms to certain logical guidelines, which are:
|
|
1. Each string element in the range array must be a valid ip address or
|
|
ip subnet mask.
|
|
2. Each string element in the geolocation array must be 2 characters,
|
|
and they can only be uppercase letters.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1auth-org~1network-config/get/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/NetworkConfiguration.yaml
|
|
responses:
|
|
'200':
|
|
description: Network configuration for the tenant.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1auth-org~1network-config/get/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/NetworkConfiguration.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$NetworkConfiguration = @"
|
|
{
|
|
"range" : [ "1.3.7.2", "255.255.255.252/30" ],
|
|
"whitelisted" : true,
|
|
"geolocation" : [ "CA", "FR", "HT" ]
|
|
}
|
|
"@
|
|
|
|
# Create security network configuration.
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToNetworkConfiguration -Json $NetworkConfiguration
|
|
New-AuthOrgNetworkConfig-NetworkConfiguration $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# New-AuthOrgNetworkConfig -NetworkConfiguration $NetworkConfiguration
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-AuthOrgNetworkConfig"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
patch:
|
|
operationId: patchAuthOrgNetworkConfig
|
|
tags:
|
|
- Global Tenant Security Settings
|
|
summary: Update security network configuration.
|
|
description: |-
|
|
This API updates an existing network configuration for an org using PATCH
|
|
Requires security scope of: 'sp:auth-org:manage'
|
|
security:
|
|
- userAuth:
|
|
- sp:auth-org:manage
|
|
requestBody:
|
|
required: true
|
|
description: |-
|
|
A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
Ensures that the patched Network Config conforms to certain logical guidelines, which are:
|
|
1. Each string element in the range array must be a valid ip address or
|
|
ip subnet mask.
|
|
2. Each string element in the geolocation array must be 2 characters,
|
|
and they can only be uppercase letters.
|
|
content:
|
|
application/json-patch+json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/JsonPatchOperation.yaml
|
|
example:
|
|
- op: replace
|
|
path: /whitelisted
|
|
value: false,
|
|
- op: add
|
|
path: /geolocation
|
|
value:
|
|
- AF
|
|
- HN
|
|
- ES
|
|
responses:
|
|
'200':
|
|
description: Updated Auth Org network configuration.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1auth-org~1network-config/get/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/NetworkConfiguration.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
# JsonPatchOperation[] | A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters.
|
|
$JsonPatchOperation = @"{
|
|
"op" : "replace",
|
|
"path" : "/description",
|
|
"value" : "New description"
|
|
}"@
|
|
|
|
|
|
# Update security network configuration.
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
|
|
Update-AuthOrgNetworkConfig-JsonPatchOperation $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Update-AuthOrgNetworkConfig -JsonPatchOperation $JsonPatchOperation
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthOrgNetworkConfig"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/auth-org/lockout-config:
|
|
get:
|
|
operationId: getAuthOrgLockoutConfig
|
|
tags:
|
|
- Global Tenant Security Settings
|
|
summary: Get Auth Org Lockout Configuration.
|
|
description: This API returns the details of an org's lockout auth configuration.
|
|
security:
|
|
- userAuth:
|
|
- sp:auth-org:read
|
|
responses:
|
|
'200':
|
|
description: Lockout configuration for the tenant's auth org.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
maximumAttempts:
|
|
type: integer
|
|
format: int32
|
|
description: The maximum attempts allowed before lockout occurs.
|
|
example: 5
|
|
lockoutDuration:
|
|
type: integer
|
|
format: int32
|
|
description: The total time in minutes a user will be locked out.
|
|
example: 15
|
|
lockoutWindow:
|
|
type: integer
|
|
format: int32
|
|
description: A rolling window where authentication attempts in a series count towards the maximum before lockout occurs.
|
|
example: 5
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
|
|
# Get Auth Org Lockout Configuration.
|
|
|
|
try {
|
|
Get-AuthOrgLockoutConfig
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-AuthOrgLockoutConfig
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AuthOrgLockoutConfig"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
patch:
|
|
operationId: patchAuthOrgLockoutConfig
|
|
tags:
|
|
- Global Tenant Security Settings
|
|
summary: Update Auth Org Lockout Configuration
|
|
description: |
|
|
This API updates an existing lockout configuration for an org using PATCH
|
|
security:
|
|
- userAuth:
|
|
- sp:auth-org:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- HELPDESK
|
|
requestBody:
|
|
required: true
|
|
description: |-
|
|
A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
Ensures that the patched Lockout Config conforms to certain logical guidelines, which are:
|
|
`1. maximumAttempts >= 1 && maximumAttempts <= 15
|
|
2. lockoutDuration >= 5 && lockoutDuration <= 60
|
|
3. lockoutWindow >= 5 && lockoutDuration <= 60`
|
|
content:
|
|
application/json-patch+json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/JsonPatchOperation.yaml
|
|
example:
|
|
- op: replace
|
|
path: /maximumAttempts
|
|
value: 7,
|
|
- op: add
|
|
path: /lockoutDuration
|
|
value: 35
|
|
responses:
|
|
'200':
|
|
description: Updated Auth Org lockout configuration.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1auth-org~1lockout-config/get/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/LockoutConfiguration.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
# JsonPatchOperation[] | A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60`
|
|
$JsonPatchOperation = @"{
|
|
"op" : "replace",
|
|
"path" : "/description",
|
|
"value" : "New description"
|
|
}"@
|
|
|
|
|
|
# Update Auth Org Lockout Configuration
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
|
|
Update-AuthOrgLockoutConfig-JsonPatchOperation $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Update-AuthOrgLockoutConfig -JsonPatchOperation $JsonPatchOperation
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthOrgLockoutConfig"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/auth-org/service-provider-config:
|
|
get:
|
|
operationId: getAuthOrgServiceProviderConfig
|
|
tags:
|
|
- Global Tenant Security Settings
|
|
summary: Get Service Provider Configuration.
|
|
description: This API returns the details of an org's service provider auth configuration.
|
|
responses:
|
|
'200':
|
|
description: Service provider configuration for the tenant.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
description: Represents the IdentityNow as Service Provider Configuration allowing customers to log into IDN via an Identity Provider
|
|
type: object
|
|
properties:
|
|
enabled:
|
|
description: This determines whether or not the SAML authentication flow is enabled for an org
|
|
type: boolean
|
|
example: true
|
|
default: false
|
|
bypassIdp:
|
|
description: This allows basic login with the parameter prompt=true. This is often toggled on when debugging SAML authentication setup. When false, only org admins with MFA-enabled can bypass the IDP.
|
|
type: boolean
|
|
example: true
|
|
default: false
|
|
samlConfigurationValid:
|
|
description: This indicates whether or not the SAML configuration is valid.
|
|
type: boolean
|
|
example: true
|
|
default: false
|
|
federationProtocolDetails:
|
|
description: A list of the abstract implementations of the Federation Protocol details. Typically, this will include on SpDetails object and one IdpDetails object used in tandem to define a SAML integration between a customer's identity provider and a customer's SailPoint instance (i.e., the service provider).
|
|
type: array
|
|
items:
|
|
oneOf:
|
|
- allOf:
|
|
- type: object
|
|
properties:
|
|
role:
|
|
type: string
|
|
description: Federation protocol role
|
|
example: SAML_IDP
|
|
enum:
|
|
- SAML_IDP
|
|
- SAML_SP
|
|
entityId:
|
|
type: string
|
|
description: An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP).
|
|
example: http://www.okta.com/exkdaruy8Ln5Ry7C54x6
|
|
- type: object
|
|
description: Specification of Identity Provider Details section of Service Provider Config
|
|
properties:
|
|
binding:
|
|
type: string
|
|
description: Defines the binding used for the SAML flow. Used with IDP configurations.
|
|
example: urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST
|
|
authContext:
|
|
type: string
|
|
description: Specifies the SAML authentication method to use. Used with IDP configurations.
|
|
example: urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport
|
|
logoutUrl:
|
|
type: string
|
|
description: The IDP logout URL. Used with IDP configurations.
|
|
example: https://dev-206445.oktapreview.com/login/signout
|
|
includeAuthContext:
|
|
type: boolean
|
|
description: Determines if the configured AuthnContext should be used or the default. Used with IDP configurations.
|
|
default: false
|
|
example: false
|
|
nameId:
|
|
type: string
|
|
description: The name id format to use. Used with IDP configurations.
|
|
example: urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress
|
|
jitConfiguration:
|
|
type: object
|
|
properties:
|
|
enabled:
|
|
type: boolean
|
|
description: The indicator for just-in-time provisioning enabled
|
|
default: false
|
|
example: false
|
|
sourceId:
|
|
type: string
|
|
description: the sourceId that mapped to just-in-time provisioning configuration
|
|
example: 2c9180857377ed2901739c12a2da5ac8
|
|
sourceAttributeMappings:
|
|
type: object
|
|
description: A mapping of identity profile attribute names to SAML assertion attribute names
|
|
additionalProperties:
|
|
type: string
|
|
description: a mapping of JIT source attributes to the SAML assertion attribute
|
|
example:
|
|
firstName: okta.firstName
|
|
lastName: okta.lastName
|
|
email: okta.email
|
|
cert:
|
|
type: string
|
|
description: The Base64-encoded certificate used by the IDP. Used with IDP configurations.
|
|
example: '-----BEGIN CERTIFICATE-----****-----END CERTIFICATE-----'
|
|
loginUrlPost:
|
|
type: string
|
|
description: The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations.
|
|
example: https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml
|
|
loginUrlRedirect:
|
|
type: string
|
|
description: The IDP Redirect URL. Used with IDP configurations.
|
|
example: https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml
|
|
mappingAttribute:
|
|
type: string
|
|
description: Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations.
|
|
example: email
|
|
role:
|
|
type: string
|
|
description: Federation protocol role
|
|
example: SAML_IDP
|
|
enum:
|
|
- SAML_IDP
|
|
certificateExpirationDate:
|
|
type: string
|
|
description: The expiration date extracted from the certificate.
|
|
example: Fri Mar 08 08:54:24 UTC 2013
|
|
certificateName:
|
|
type: string
|
|
description: The name extracted from the certificate.
|
|
example: OU=Conext, O=Surfnet, L=Utrecht, ST=Utrecht, C=NL
|
|
- allOf:
|
|
- $ref: '#/paths/~1auth-org~1service-provider-config/get/responses/200/content/application~1json/schema/properties/federationProtocolDetails/items/oneOf/0/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/FederationProtocolDetails.yaml
|
|
- type: object
|
|
description: Specification of a Service Provider Details
|
|
properties:
|
|
role:
|
|
type: string
|
|
description: Federation protocol role
|
|
example: SAML_SP
|
|
enum:
|
|
- SAML_SP
|
|
alias:
|
|
type: string
|
|
description: Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations.
|
|
example: acme-sp
|
|
callbackUrl:
|
|
type: string
|
|
description: The allowed callback URL where users will be redirected to after authentication. Used with SP configurations.
|
|
example: https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp
|
|
example:
|
|
- role: SAML_IDP
|
|
entityId: http://www.okta.com/exktq4o24bmQA4fr60h7
|
|
cert: MIIDpDCCAoygAwIBAgIGAYhZ+b29MA0GCSqGSIb3DQEBCwUAMIGSMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxEzARBgNVBAMMCmRldi0yMDY0NDUxHDAaBgkqhkiG9w0BCQEWDWluZm9Ab2t0YS5jb20wHhcNMjMwNTI2MjEzMDU5WhcNMzMwNTI2MjEzMTU5WjCBkjELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xDTALBgNVBAoMBE9rdGExFDASBgNVBAsMC1NTT1Byb3ZpZGVyMRMwEQYDVQQDDApkZXYtMjA2NDQ1MRwwGgYJKoZIhvcNAQkBFg1pbmZvQG9rdGEuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwvi1+WbF2ceGlLCrLl5PrG1lpj04IsrHX6OE666ObC2WFh+Nxvpxy+Vmzon9c9+akhK3bTv+9ifEoVc6tA1qWuCfXISAn9g81JqI68I1PGUbe6eF8pmOA18rjOrt7x94k4QukpR3+I8DfPJ+TynatltB51laLb8H4jchMafA4rDTjV/ZiYPxV0LMEIbprVyGuvBEhiEWha3wwVdDuJq996okX36YNS8PcGH+5CJ8c3YWZp/wrspgJmfCooMXeV+6zBpZfXqPpMWlUo0gcZqDOFgy3r4vkXehJdVYRlInMfDv04Lvy8VI1YAZClG/duO/6o9YVUFLjD9s+mQfhgaF5wIDAQABMA0GCSqGSIb3DQEBCwUAA4IBAQB1CTrA/pTHkarbhMHsdSFAjVoYWwdAfrssG99rIjwwr/CW9tavTC3keaoUmUeddcnLY4V/TfL07+xgQGHCBR88cnzG9h6rC9qWxt6C3nug3YDVQfkdCDgnW9A8QEvLeq/KVLoRccpJNEENb2Y5ESUXHi1+PtjkFBtvfSgZ4eEhVggirL0bJdWVm700hCnjb2iCGSbSX7WflfPi0GSmjht983caG9OwZDnDzNFt8qGWCxo4bNSThT00JnWEN/6f1BWNOt9YDrxqEyNclqhLL+RDqFsPBFIrQlsoXzqpWqCL8oS9UMNxbGATK2v3d5ueE9+SswBAFBhirCuqZw19Ri2W
|
|
loginUrlPost: https://dev-206445.oktapreview.com/app/tivolidev206445_acmeidntest_1/exktq4o24bmQA4fr60h7/sso/saml
|
|
loginUrlRedirect: https://dev-206445.oktapreview.com/app/tivolidev206445_acmeidntest_1/exktq4o24bmQA4fr60h7/sso/saml
|
|
logoutUrl: https://dev-206445.oktapreview.com/login/signout
|
|
nameId: urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress
|
|
binding: urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST
|
|
authnContext: urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport
|
|
includeAuthnContext: true
|
|
mappingAttribute: email
|
|
jitConfiguration:
|
|
enabled: true
|
|
sourceId: 2c9180897427f3a501745042afc83144
|
|
sourceAttributeMappings:
|
|
firstName: okta.firstName
|
|
lastName: okta.lastName
|
|
email: okta.email
|
|
certificateExpirationDate: Thu May 26 21:31:59 GMT 2033
|
|
certificateName: EMAILADDRESS=info@okta.com, CN=dev-206445, OU=SSOProvider, O=Okta, L=San Francisco, ST=California, C=US
|
|
- role: SAML_SP
|
|
entityId: https://acme.identitysoon.com/sp
|
|
alias: acme-sp
|
|
callbackUrl: https://acme.test-login.sailpoint.com/saml/SSO/alias/acme-sp
|
|
legacyAcsUrl: https://megapod-useast1-sso.identitysoon.com/sso/Consumer/metaAlias/acme/sp
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth: []
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
|
|
# Get Service Provider Configuration.
|
|
|
|
try {
|
|
Get-AuthOrgServiceProviderConfig
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-AuthOrgServiceProviderConfig
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AuthOrgServiceProviderConfig"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
patch:
|
|
operationId: patchAuthOrgServiceProviderConfig
|
|
tags:
|
|
- Global Tenant Security Settings
|
|
summary: Update Service Provider Configuration
|
|
description: This API updates an existing service provider configuration for an org using PATCH.
|
|
requestBody:
|
|
required: true
|
|
description: |-
|
|
A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails
|
|
Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are:
|
|
1. Do not add or remove any elements in the federation protocol details
|
|
in the service provider configuration.
|
|
2. Do not modify, add, or delete the service provider details element in
|
|
the federation protocol details.
|
|
3. If this is the first time the patched ServiceProviderConfig enables
|
|
Remote IDP sign-in, it must also include IDPDetails.
|
|
4. If the patch enables Remote IDP sign in, the entityID in the
|
|
IDPDetails cannot be null. IDPDetails must include an entityID.
|
|
5. Any JIT configuration update must be valid.
|
|
|
|
Just in time configuration update must be valid when enabled. This includes:
|
|
- A Source ID
|
|
- Source attribute mappings
|
|
- Source attribute maps have all the required key values (firstName,
|
|
lastName, email)
|
|
content:
|
|
application/json-patch+json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/JsonPatchOperation.yaml
|
|
example:
|
|
- op: replace
|
|
path: /enabled
|
|
value: true,
|
|
- op: add
|
|
path: /federationProtocolDetails/0/jitConfiguration
|
|
value:
|
|
enabled: true
|
|
sourceId: 2c9180857377ed2901739c12a2da5ac8
|
|
sourceAttributeMappings:
|
|
firstName: okta.firstName
|
|
lastName: okta.lastName
|
|
email: okta.email
|
|
employeeNumber: okta.employeeNumber
|
|
responses:
|
|
'200':
|
|
description: Auth Org Service Provider configuration updated.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1auth-org~1service-provider-config/get/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ServiceProviderConfiguration.yaml
|
|
'400':
|
|
description: Client Error - Returned if the request body is invalid.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/400/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ErrorResponseDto.yaml
|
|
examples:
|
|
400.1 Bad Request Content:
|
|
description: Response for bad request content
|
|
value:
|
|
detailCode: 400.1 Bad Request Content
|
|
trackingId: e7eab60924f64aa284175b9fa3309599
|
|
messages:
|
|
- locale: en
|
|
localeOrigin: REQUEST
|
|
text: firstName is required; accountName is required;
|
|
400.1.3 Illegal value:
|
|
description: Response for Illegal value
|
|
value:
|
|
detailCode: 400.1.3 Illegal value
|
|
trackingId: e7eab60924f64aa284175b9fa3309599
|
|
messages:
|
|
- locale: en
|
|
localeOrigin: REQUEST
|
|
text: JIT source id is invalid.
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth: []
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
# JsonPatchOperation[] | A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email)
|
|
$JsonPatchOperation = @"{
|
|
"op" : "replace",
|
|
"path" : "/description",
|
|
"value" : "New description"
|
|
}"@
|
|
|
|
|
|
# Update Service Provider Configuration
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
|
|
Update-AuthOrgServiceProviderConfig-JsonPatchOperation $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Update-AuthOrgServiceProviderConfig -JsonPatchOperation $JsonPatchOperation
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthOrgServiceProviderConfig"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/auth-org/session-config:
|
|
get:
|
|
operationId: getAuthOrgSessionConfig
|
|
tags:
|
|
- Global Tenant Security Settings
|
|
summary: Get Auth Org Session Configuration.
|
|
description: This API returns the details of an org's session auth configuration.
|
|
security:
|
|
- userAuth:
|
|
- sp:auth-org:read
|
|
responses:
|
|
'200':
|
|
description: Session configuration for the tenant's auth org.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
maxIdleTime:
|
|
type: integer
|
|
format: int32
|
|
description: The maximum time in minutes a session can be idle.
|
|
example: 15
|
|
rememberMe:
|
|
type: boolean
|
|
description: Denotes if 'remember me' is enabled.
|
|
default: false
|
|
example: true
|
|
maxSessionTime:
|
|
type: integer
|
|
format: int32
|
|
description: The maximum allowable session time in minutes.
|
|
example: 45
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
|
|
# Get Auth Org Session Configuration.
|
|
|
|
try {
|
|
Get-AuthOrgSessionConfig
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-AuthOrgSessionConfig
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AuthOrgSessionConfig"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
patch:
|
|
operationId: patchAuthOrgSessionConfig
|
|
tags:
|
|
- Global Tenant Security Settings
|
|
summary: Update Auth Org Session Configuration
|
|
description: This API updates an existing session configuration for an org using PATCH.
|
|
security:
|
|
- userAuth:
|
|
- sp:auth-org:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- HELPDESK
|
|
requestBody:
|
|
required: true
|
|
description: |
|
|
A list of auth org session configuration update operations according to
|
|
the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
|
|
Ensures that the patched Session Config conforms to certain logical
|
|
guidelines, which are:
|
|
`1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week)
|
|
2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day)
|
|
3. maxSessionTime must have a greater duration than maxIdleTime.`
|
|
content:
|
|
application/json-patch+json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/JsonPatchOperation.yaml
|
|
example:
|
|
- op: replace
|
|
path: /rememberMe
|
|
value: true,
|
|
- op: add
|
|
path: /maxSessionTime
|
|
value: 480
|
|
responses:
|
|
'200':
|
|
description: Updated Auth Org session configuration.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1auth-org~1session-config/get/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/SessionConfiguration.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
# JsonPatchOperation[] | A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.`
|
|
$JsonPatchOperation = @"{
|
|
"op" : "replace",
|
|
"path" : "/description",
|
|
"value" : "New description"
|
|
}"@
|
|
|
|
|
|
# Update Auth Org Session Configuration
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
|
|
Update-AuthOrgSessionConfig-JsonPatchOperation $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Update-AuthOrgSessionConfig -JsonPatchOperation $JsonPatchOperation
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthOrgSessionConfig"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/auth-users/{id}:
|
|
get:
|
|
operationId: getAuthUser
|
|
tags:
|
|
- Auth Users
|
|
summary: Auth User Details
|
|
description: Return the specified user's authentication system details.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
description: Identity ID
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listIdentities
|
|
schema:
|
|
type: string
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
security:
|
|
- userAuth:
|
|
- sp:auth-user:read
|
|
responses:
|
|
'200':
|
|
description: The specified user's authentication system details.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
tenant:
|
|
type: string
|
|
description: Tenant name.
|
|
example: test-tenant
|
|
id:
|
|
type: string
|
|
description: Identity ID.
|
|
example: 2c91808458ae7a4f0158b1bbf8af0628
|
|
uid:
|
|
type: string
|
|
description: Identity's unique identitifier.
|
|
example: will.smith
|
|
profile:
|
|
type: string
|
|
description: ID of the auth profile associated with the auth user.
|
|
example: 2c91808458ae7a4f0158b1bbf8af0756
|
|
identificationNumber:
|
|
type: string
|
|
description: Auth user's employee number.
|
|
example: 19-5588452
|
|
email:
|
|
type: string
|
|
description: Auth user's email.
|
|
example: william.smith@example.com
|
|
phone:
|
|
type: string
|
|
description: Auth user's phone number.
|
|
example: '5555555555'
|
|
workPhone:
|
|
type: string
|
|
description: Auth user's work phone number.
|
|
example: '5555555555'
|
|
personalEmail:
|
|
type: string
|
|
description: Auth user's personal email.
|
|
example: william.smith@example.com
|
|
firstname:
|
|
type: string
|
|
description: Auth user's first name.
|
|
example: Will
|
|
lastname:
|
|
type: string
|
|
description: Auth user's last name.
|
|
example: Smith
|
|
displayName:
|
|
type: string
|
|
description: Auth user's name in displayed format.
|
|
example: Will Smith
|
|
alias:
|
|
type: string
|
|
description: Auth user's alias.
|
|
example: will.smith
|
|
lastPasswordChangeDate:
|
|
type: string
|
|
description: Date of last password change.
|
|
example: '2021-03-08T22:37:33.901Z'
|
|
lastLoginTimestamp:
|
|
description: Timestamp of the last login (long type value).
|
|
type: integer
|
|
format: int64
|
|
example: 1656327185832
|
|
currentLoginTimestamp:
|
|
description: Timestamp of the current login (long type value).
|
|
type: integer
|
|
format: int64
|
|
example: 1656327185832
|
|
capabilities:
|
|
description: Array of the auth user's capabilities.
|
|
type: array
|
|
items:
|
|
type: string
|
|
enum:
|
|
- CERT_ADMIN
|
|
- CLOUD_GOV_ADMIN
|
|
- CLOUD_GOV_USER
|
|
- HELPDESK
|
|
- ORG_ADMIN
|
|
- REPORT_ADMIN
|
|
- ROLE_ADMIN
|
|
- ROLE_SUBADMIN
|
|
- SAAS_MANAGEMENT_ADMIN
|
|
- SAAS_MANAGEMENT_READER
|
|
- SOURCE_ADMIN
|
|
- SOURCE_SUBADMIN
|
|
- das:ui-administrator
|
|
- das:ui-compliance_manager
|
|
- das:ui-auditor
|
|
- das:ui-data-scope
|
|
- sp:aic-dashboard-read
|
|
- sp:aic-dashboard-write
|
|
- sp:ui-config-hub-admin
|
|
- sp:ui-config-hub-backup-admin
|
|
- sp:ui-config-hub-read
|
|
example: ORG_ADMIN
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID
|
|
|
|
# Auth User Details
|
|
|
|
try {
|
|
Get-AuthUser-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-AuthUser -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AuthUser"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
patch:
|
|
operationId: patchAuthUser
|
|
tags:
|
|
- Auth Users
|
|
summary: Auth User Update
|
|
description: |-
|
|
Use a PATCH request to update an existing user in the authentication system.
|
|
Use this endpoint to modify these fields:
|
|
* `capabilities`
|
|
|
|
A '400.1.1 Illegal update attempt' detail code indicates that you attempted to PATCH a field that is not allowed.
|
|
security:
|
|
- userAuth:
|
|
- sp:auth-user:update
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
description: Identity ID
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listIdentities
|
|
schema:
|
|
type: string
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
requestBody:
|
|
required: true
|
|
description: A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
content:
|
|
application/json-patch+json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/JsonPatchOperation.yaml
|
|
example:
|
|
- op: replace
|
|
path: /capabilities
|
|
value:
|
|
- ORG_ADMIN
|
|
responses:
|
|
'200':
|
|
description: Auth user updated.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1auth-users~1%7Bid%7D/get/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/AuthUser.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID
|
|
# JsonPatchOperation[] | A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
$JsonPatchOperation = @"{
|
|
"op" : "replace",
|
|
"path" : "/description",
|
|
"value" : "New description"
|
|
}"@
|
|
|
|
|
|
# Auth User Update
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
|
|
Update-AuthUser-Id $Id -JsonPatchOperation $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Update-AuthUser -Id $Id -JsonPatchOperation $JsonPatchOperation
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthUser"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/brandings:
|
|
get:
|
|
operationId: getBrandingList
|
|
tags:
|
|
- Branding
|
|
summary: List of branding items
|
|
description: This API endpoint returns a list of branding items.
|
|
security:
|
|
- userAuth:
|
|
- idn:branding:read
|
|
- applicationAuth:
|
|
- idn:branding:read
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
responses:
|
|
'200':
|
|
description: A list of branding items.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: name of branding item
|
|
example: default
|
|
productName:
|
|
type: string
|
|
description: product name
|
|
example: product name
|
|
nullable: true
|
|
actionButtonColor:
|
|
type: string
|
|
description: hex value of color for action button
|
|
example: 0074D9
|
|
nullable: true
|
|
activeLinkColor:
|
|
type: string
|
|
description: hex value of color for link
|
|
example: 1.1e+70
|
|
nullable: true
|
|
navigationColor:
|
|
type: string
|
|
description: hex value of color for navigation bar
|
|
example: 1.1e+70
|
|
nullable: true
|
|
emailFromAddress:
|
|
type: string
|
|
description: email from address
|
|
example: no-reply@sailpoint.com
|
|
nullable: true
|
|
standardLogoURL:
|
|
type: string
|
|
description: url to standard logo
|
|
example: ''
|
|
nullable: true
|
|
loginInformationalMessage:
|
|
type: string
|
|
description: login information message
|
|
example: ''
|
|
nullable: true
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
|
|
# List of branding items
|
|
|
|
try {
|
|
Get-BrandingList
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-BrandingList
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BrandingList"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
post:
|
|
operationId: createBrandingItem
|
|
tags:
|
|
- Branding
|
|
summary: Create a branding item
|
|
description: This API endpoint creates a branding item.
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
multipart/form-data:
|
|
schema:
|
|
type: object
|
|
required:
|
|
- name
|
|
- productName
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: name of branding item
|
|
example: custom-branding-item
|
|
productName:
|
|
type: string
|
|
description: product name
|
|
example: product name
|
|
nullable: true
|
|
actionButtonColor:
|
|
type: string
|
|
description: hex value of color for action button
|
|
example: 0074D9
|
|
activeLinkColor:
|
|
type: string
|
|
description: hex value of color for link
|
|
example: 1.1e+70
|
|
navigationColor:
|
|
type: string
|
|
description: hex value of color for navigation bar
|
|
example: 1.1e+70
|
|
emailFromAddress:
|
|
type: string
|
|
description: email from address
|
|
example: no-reply@sailpoint.com
|
|
loginInformationalMessage:
|
|
type: string
|
|
description: login information message
|
|
example: ''
|
|
fileStandard:
|
|
type: string
|
|
format: binary
|
|
description: png file with logo
|
|
example: \x00\x00\x00\x02
|
|
security:
|
|
- userAuth:
|
|
- idn:branding:manage
|
|
- applicationAuth:
|
|
- idn:branding:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
responses:
|
|
'201':
|
|
description: Branding item created
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1brandings/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/BrandingItem.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Name = "MyName" # String | name of branding item
|
|
$ProductName = "MyProductName" # String | product name
|
|
$ActionButtonColor = "MyActionButtonColor" # String | hex value of color for action button (optional)
|
|
$ActiveLinkColor = "MyActiveLinkColor" # String | hex value of color for link (optional)
|
|
$NavigationColor = "MyNavigationColor" # String | hex value of color for navigation bar (optional)
|
|
$EmailFromAddress = "MyEmailFromAddress" # String | email from address (optional)
|
|
$LoginInformationalMessage = "MyLoginInformationalMessage" # String | login information message (optional)
|
|
$FileStandard = # System.IO.FileInfo | png file with logo (optional)
|
|
|
|
# Create a branding item
|
|
|
|
try {
|
|
New-BrandingItem-Name $Name -ProductName $ProductName
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# New-BrandingItem -Name $Name -ProductName $ProductName -ActionButtonColor $ActionButtonColor -ActiveLinkColor $ActiveLinkColor -NavigationColor $NavigationColor -EmailFromAddress $EmailFromAddress -LoginInformationalMessage $LoginInformationalMessage -FileStandard $FileStandard
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BrandingItem"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/brandings/{name}:
|
|
get:
|
|
operationId: getBranding
|
|
tags:
|
|
- Branding
|
|
summary: Get a branding item
|
|
description: 'This API endpoint retrieves information for an existing branding item by name. '
|
|
security:
|
|
- userAuth:
|
|
- idn:branding:read
|
|
- applicationAuth:
|
|
- idn:branding:read
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
parameters:
|
|
- in: path
|
|
name: name
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getBrandingList
|
|
description: The name of the branding item to be retrieved
|
|
example: default
|
|
responses:
|
|
'200':
|
|
description: A branding item object
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1brandings/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/BrandingItem.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Name = "default" # String | The name of the branding item to be retrieved
|
|
|
|
# Get a branding item
|
|
|
|
try {
|
|
Get-Branding-Name $Name
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-Branding -Name $Name
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Branding"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
put:
|
|
operationId: setBrandingItem
|
|
tags:
|
|
- Branding
|
|
summary: Update a branding item
|
|
description: This API endpoint updates information for an existing branding item.
|
|
parameters:
|
|
- in: path
|
|
name: name
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getBrandingList
|
|
description: The name of the branding item to be retrieved
|
|
example: default
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/paths/~1brandings/post/requestBody/content/multipart~1form-data/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/BrandingItemCreate.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:branding:manage
|
|
- applicationAuth:
|
|
- idn:branding:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
responses:
|
|
'200':
|
|
description: Branding item updated
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1brandings/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/BrandingItem.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Name = "default" # String | The name of the branding item to be retrieved
|
|
$Name2 = "Name_example" # String | name of branding item
|
|
$ProductName = "MyProductName" # String | product name
|
|
$ActionButtonColor = "MyActionButtonColor" # String | hex value of color for action button (optional)
|
|
$ActiveLinkColor = "MyActiveLinkColor" # String | hex value of color for link (optional)
|
|
$NavigationColor = "MyNavigationColor" # String | hex value of color for navigation bar (optional)
|
|
$EmailFromAddress = "MyEmailFromAddress" # String | email from address (optional)
|
|
$LoginInformationalMessage = "MyLoginInformationalMessage" # String | login information message (optional)
|
|
$FileStandard = # System.IO.FileInfo | png file with logo (optional)
|
|
|
|
# Update a branding item
|
|
|
|
try {
|
|
Set-BrandingItem-Name $Name -Name2 $Name2 -ProductName $ProductName
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Set-BrandingItem -Name $Name -Name2 $Name2 -ProductName $ProductName -ActionButtonColor $ActionButtonColor -ActiveLinkColor $ActiveLinkColor -NavigationColor $NavigationColor -EmailFromAddress $EmailFromAddress -LoginInformationalMessage $LoginInformationalMessage -FileStandard $FileStandard
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BrandingItem"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
delete:
|
|
operationId: deleteBranding
|
|
tags:
|
|
- Branding
|
|
summary: Delete a branding item
|
|
description: 'This API endpoint delete information for an existing branding item by name. '
|
|
security:
|
|
- userAuth:
|
|
- idn:branding:manage
|
|
- applicationAuth:
|
|
- idn:branding:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
parameters:
|
|
- in: path
|
|
name: name
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getBrandingList
|
|
description: The name of the branding item to be deleted
|
|
example: default
|
|
responses:
|
|
'204':
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/204.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Name = "default" # String | The name of the branding item to be deleted
|
|
|
|
# Delete a branding item
|
|
|
|
try {
|
|
Remove-Branding-Name $Name
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Remove-Branding -Name $Name
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Branding"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/campaigns:
|
|
get:
|
|
operationId: getActiveCampaigns
|
|
tags:
|
|
- Certification Campaigns
|
|
summary: List Campaigns
|
|
description: |
|
|
Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query.
|
|
security:
|
|
- userAuth:
|
|
- idn:campaign:read
|
|
- idn:campaign:manage
|
|
- idn:campaign-report:read
|
|
- idn:campaign-report:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- CERT_ADMIN
|
|
- REPORT_ADMIN
|
|
parameters:
|
|
- in: query
|
|
name: detail
|
|
schema:
|
|
type: string
|
|
enum:
|
|
- SLIM
|
|
- FULL
|
|
required: false
|
|
description: Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior.
|
|
example: FULL
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
- in: query
|
|
name: filters
|
|
schema:
|
|
type: string
|
|
required: false
|
|
description: |-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
**id**: *eq, in*
|
|
|
|
**name**: *eq, sw*
|
|
|
|
**status**: *eq, in*
|
|
example: name eq "Manager Campaign"
|
|
- in: query
|
|
name: sorters
|
|
schema:
|
|
type: string
|
|
format: comma-separated
|
|
required: false
|
|
description: |-
|
|
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
|
|
|
Sorting is supported for the following fields: **name, created**
|
|
example: name
|
|
responses:
|
|
'200':
|
|
description: A list of campaign objects. By default list of SLIM campaigns is returned.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
anyOf:
|
|
- type: object
|
|
title: Slim Campaign
|
|
required:
|
|
- name
|
|
- description
|
|
- type
|
|
properties:
|
|
id:
|
|
type: string
|
|
readOnly: true
|
|
description: Id of the campaign
|
|
example: 2c9079b270a266a60170a2779fcb0007
|
|
name:
|
|
description: |
|
|
The campaign name. If this object is part of a template, special formatting applies; see the
|
|
`/campaign-templates/{id}/generate` endpoint documentation for details.
|
|
type: string
|
|
example: Manager Campaign
|
|
description:
|
|
type: string
|
|
nullable: true
|
|
description: |
|
|
The campaign description. If this object is part of a template, special formatting applies; see the
|
|
`/campaign-templates/{id}/generate` endpoint documentation for details.
|
|
example: Everyone needs to be reviewed by their manager
|
|
deadline:
|
|
type: string
|
|
format: date-time
|
|
description: The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response.
|
|
example: '2020-03-15T10:00:01.456Z'
|
|
type:
|
|
type: string
|
|
description: The type of campaign. Could be extended in the future.
|
|
enum:
|
|
- MANAGER
|
|
- SOURCE_OWNER
|
|
- SEARCH
|
|
- ROLE_COMPOSITION
|
|
- MACHINE_ACCOUNT
|
|
example: MANAGER
|
|
emailNotificationEnabled:
|
|
type: boolean
|
|
description: Enables email notification for this campaign
|
|
default: false
|
|
example: false
|
|
autoRevokeAllowed:
|
|
type: boolean
|
|
description: Allows auto revoke for this campaign
|
|
default: false
|
|
example: false
|
|
recommendationsEnabled:
|
|
type: boolean
|
|
description: Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future.
|
|
default: false
|
|
example: true
|
|
status:
|
|
type: string
|
|
description: The campaign's current status.
|
|
readOnly: true
|
|
enum:
|
|
- PENDING
|
|
- STAGED
|
|
- CANCELING
|
|
- ACTIVATING
|
|
- ACTIVE
|
|
- COMPLETING
|
|
- COMPLETED
|
|
- ERROR
|
|
- ARCHIVED
|
|
example: ACTIVE
|
|
correlatedStatus:
|
|
type: string
|
|
description: The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).
|
|
enum:
|
|
- CORRELATED
|
|
- UNCORRELATED
|
|
example: CORRELATED
|
|
created:
|
|
type: string
|
|
readOnly: true
|
|
format: date-time
|
|
description: Created time of the campaign
|
|
example: '2020-03-03T22:15:13.611Z'
|
|
totalCertifications:
|
|
type: integer
|
|
format: int32
|
|
description: The total number of certifications in this campaign.
|
|
readOnly: true
|
|
example: 100
|
|
completedCertifications:
|
|
type: integer
|
|
format: int32
|
|
description: The number of completed certifications in this campaign.
|
|
readOnly: true
|
|
example: 10
|
|
alerts:
|
|
type: array
|
|
description: A list of errors and warnings that have accumulated.
|
|
readOnly: true
|
|
items:
|
|
type: object
|
|
properties:
|
|
level:
|
|
type: string
|
|
enum:
|
|
- ERROR
|
|
- WARN
|
|
- INFO
|
|
description: Denotes the level of the message
|
|
example: ERROR
|
|
localizations:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/400/content/application~1json/schema/properties/messages/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ErrorMessageDto.yaml
|
|
- type: object
|
|
title: Campaign
|
|
allOf:
|
|
- $ref: '#/paths/~1campaigns/get/responses/200/content/application~1json/schema/items/anyOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/SlimCampaign.yaml
|
|
- type: object
|
|
properties:
|
|
modified:
|
|
type: string
|
|
readOnly: true
|
|
format: date-time
|
|
description: Modified time of the campaign
|
|
example: '2020-03-03T22:20:12.674Z'
|
|
correlatedStatus:
|
|
type: string
|
|
description: The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).
|
|
enum:
|
|
- CORRELATED
|
|
- UNCORRELATED
|
|
example: CORRELATED
|
|
filter:
|
|
type: object
|
|
description: Determines which items will be included in this campaign. The default campaign filter is used if this field is left blank.
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The ID of whatever type of filter is being used.
|
|
example: 0fbe863c063c4c88a35fd7f17e8a3df5
|
|
type:
|
|
type: string
|
|
description: Type of the filter
|
|
enum:
|
|
- CAMPAIGN_FILTER
|
|
- RULE
|
|
example: CAMPAIGN_FILTER
|
|
name:
|
|
type: string
|
|
description: Name of the filter
|
|
example: Test Filter
|
|
sunsetCommentsRequired:
|
|
type: boolean
|
|
description: Determines if comments on sunset date changes are required.
|
|
default: true
|
|
example: true
|
|
sourceOwnerCampaignInfo:
|
|
type: object
|
|
description: Must be set only if the campaign type is SOURCE_OWNER.
|
|
properties:
|
|
sourceIds:
|
|
type: array
|
|
description: The list of sources to be included in the campaign.
|
|
items:
|
|
type: string
|
|
example:
|
|
- 0fbe863c063c4c88a35fd7f17e8a3df5
|
|
searchCampaignInfo:
|
|
type: object
|
|
description: Must be set only if the campaign type is SEARCH.
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: The type of search campaign represented.
|
|
enum:
|
|
- IDENTITY
|
|
- ACCESS
|
|
example: ACCESS
|
|
description:
|
|
type: string
|
|
description: Describes this search campaign. Intended for storing the query used, and possibly the number of identities selected/available.
|
|
example: Search Campaign description
|
|
reviewer:
|
|
type: object
|
|
description: If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP.
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: The reviewer's DTO type.
|
|
enum:
|
|
- GOVERNANCE_GROUP
|
|
- IDENTITY
|
|
example: IDENTITY
|
|
id:
|
|
type: string
|
|
description: The reviewer's ID.
|
|
example: 2c91808568c529c60168cca6f90c1313
|
|
name:
|
|
type: string
|
|
description: The reviewer's name.
|
|
example: William Wilson
|
|
query:
|
|
type: string
|
|
description: The scope for the campaign. The campaign will cover identities returned by the query and identities that have access items returned by the query. One of `query` or `identityIds` must be set.
|
|
example: Search Campaign query description
|
|
identityIds:
|
|
type: array
|
|
description: A direct list of identities to include in this campaign. One of `identityIds` or `query` must be set.
|
|
items:
|
|
type: string
|
|
maxItems: 1000
|
|
example:
|
|
- 0fbe863c063c4c88a35fd7f17e8a3df5
|
|
accessConstraints:
|
|
type: array
|
|
description: Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access.
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
enum:
|
|
- ENTITLEMENT
|
|
- ACCESS_PROFILE
|
|
- ROLE
|
|
description: Type of Access
|
|
example: ENTITLEMENT
|
|
ids:
|
|
description: Must be set only if operator is SELECTED.
|
|
type: array
|
|
items:
|
|
type: string
|
|
example:
|
|
- 2c90ad2a70ace7d50170acf22ca90010
|
|
operator:
|
|
type: string
|
|
enum:
|
|
- ALL
|
|
- SELECTED
|
|
description: Used to determine whether the scope of the campaign should be reduced for selected ids or all.
|
|
example: SELECTED
|
|
required:
|
|
- type
|
|
- operator
|
|
maxItems: 1000
|
|
required:
|
|
- type
|
|
roleCompositionCampaignInfo:
|
|
type: object
|
|
description: Optional configuration options for role composition campaigns.
|
|
properties:
|
|
reviewer:
|
|
type: object
|
|
description: If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP.
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: The reviewer's DTO type.
|
|
enum:
|
|
- GOVERNANCE_GROUP
|
|
- IDENTITY
|
|
example: IDENTITY
|
|
id:
|
|
type: string
|
|
description: The reviewer's ID.
|
|
example: 2c91808568c529c60168cca6f90c1313
|
|
name:
|
|
type: string
|
|
description: The reviewer's name.
|
|
example: William Wilson
|
|
roleIds:
|
|
type: array
|
|
description: Optional list of roles to include in this campaign. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included.
|
|
items:
|
|
type: string
|
|
example:
|
|
- 2c90ad2a70ace7d50170acf22ca90010
|
|
remediatorRef:
|
|
type: object
|
|
description: This determines who remediation tasks will be assigned to. Remediation tasks are created for each revoke decision on items in the campaign. The only legal remediator type is 'IDENTITY', and the chosen identity must be a Role Admin or Org Admin.
|
|
properties:
|
|
type:
|
|
type: string
|
|
enum:
|
|
- IDENTITY
|
|
description: Legal Remediator Type
|
|
example: IDENTITY
|
|
id:
|
|
type: string
|
|
description: The ID of the remediator.
|
|
example: 2c90ad2a70ace7d50170acf22ca90010
|
|
name:
|
|
type: string
|
|
description: The name of the remediator.
|
|
readOnly: true
|
|
example: Role Admin
|
|
required:
|
|
- type
|
|
- id
|
|
query:
|
|
type: string
|
|
description: Optional search query to scope this campaign to a set of roles. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included.
|
|
example: Search Query
|
|
description:
|
|
type: string
|
|
description: Describes this role composition campaign. Intended for storing the query used, and possibly the number of roles selected/available.
|
|
example: Role Composition Description
|
|
required:
|
|
- remediatorRef
|
|
machineAccountCampaignInfo:
|
|
type: object
|
|
description: Must be set only if the campaign type is MACHINE_ACCOUNT.
|
|
properties:
|
|
sourceIds:
|
|
type: array
|
|
description: The list of sources to be included in the campaign.
|
|
items:
|
|
type: string
|
|
example:
|
|
- 0fbe863c063c4c88a35fd7f17e8a3df5
|
|
reviewerType:
|
|
type: string
|
|
description: The reviewer's type.
|
|
enum:
|
|
- ACCOUNT_OWNER
|
|
example: ACCOUNT_OWNER
|
|
sourcesWithOrphanEntitlements:
|
|
type: array
|
|
description: A list of sources in the campaign that contain \"orphan entitlements\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented).
|
|
readOnly: true
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: Id of the source
|
|
example: 2c90ad2a70ace7d50170acf22ca90010
|
|
type:
|
|
type: string
|
|
enum:
|
|
- SOURCE
|
|
description: Type
|
|
example: SOURCE
|
|
name:
|
|
type: string
|
|
description: Name of the source
|
|
example: Source with orphan entitlements
|
|
mandatoryCommentRequirement:
|
|
type: string
|
|
description: Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions.
|
|
enum:
|
|
- ALL_DECISIONS
|
|
- REVOKE_ONLY_DECISIONS
|
|
- NO_DECISIONS
|
|
example: NO_DECISIONS
|
|
examples:
|
|
Slim Campaign:
|
|
description: List of Slim Campaigns that would result from not specifying *detail* or specifying SLIM
|
|
value:
|
|
- id: 2c918086719eec070171a7e3355a360a
|
|
name: Manager Review
|
|
description: A review of everyone's access by their manager.
|
|
deadline: '2020-12-25T06:00:00.123Z'
|
|
type: MANAGER
|
|
status: ACTIVE
|
|
emailNotificationEnabled: false
|
|
autoRevokeAllowed: false
|
|
recommendationsEnabled: false
|
|
created: '2022-08-02T19:00:27.731Z'
|
|
totalCertifications: 10
|
|
completedCertifications: 3
|
|
alerts:
|
|
- level: ERROR
|
|
localizations:
|
|
- locale: en
|
|
localeOrigin: DEFAULT
|
|
text: Composite criterion must have children non-composite criterion must not.
|
|
- id: 7e1a731e3fb845cfbe58112ba4673ee4
|
|
name: Search Campaign
|
|
description: Search Campaign Info
|
|
deadline: '2022-07-26T15:42:44.000Z'
|
|
type: SEARCH
|
|
status: ACTIVE
|
|
emailNotificationEnabled: false
|
|
autoRevokeAllowed: false
|
|
recommendationsEnabled: false
|
|
created: '2022-07-25T15:42:18.276Z'
|
|
totalCertifications: 5
|
|
completedCertifications: 3
|
|
alerts: null
|
|
- id: 2c918086719eec070171a7e3355a412b
|
|
name: AD Source Review
|
|
description: A review of our AD source.
|
|
deadline: '2020-12-25T06:00:00.123Z'
|
|
type: SOURCE_OWNER
|
|
status: STAGED
|
|
emailNotificationEnabled: true
|
|
autoRevokeAllowed: false
|
|
recommendationsEnabled: false
|
|
correlatedStatus: CORRELATED
|
|
created: '2022-07-27T17:04:19.027Z'
|
|
totalCertifications: 7
|
|
completedCertifications: 3
|
|
alerts:
|
|
- level: WARN
|
|
localizations:
|
|
- locale: en
|
|
localeOrigin: DEFAULT
|
|
text: Composite criterion is in wrong format.
|
|
- id: 3b2e2e5821e84127b6d693d41c40623b
|
|
name: Role Composition Campaign
|
|
description: A review done by a role owner.
|
|
deadline: '2020-12-25T06:00:00.468Z'
|
|
type: ROLE_COMPOSITION
|
|
status: ACTIVE
|
|
emailNotificationEnabled: false
|
|
autoRevokeAllowed: false
|
|
recommendationsEnabled: false
|
|
created: '2022-08-02T20:29:51.065Z'
|
|
totalCertifications: 1
|
|
completedCertifications: 1
|
|
alerts: null
|
|
Full Campaign:
|
|
description: List of Campaigns that would result from specifying *detail* as FULL
|
|
value:
|
|
- id: 078696a575e045c68d6722ccdb9f101d
|
|
name: Role Composition Campaign
|
|
description: A review done by a role owner.
|
|
deadline: '2020-12-25T06:00:00.468Z'
|
|
type: ROLE_COMPOSITION
|
|
status: ERROR
|
|
emailNotificationEnabled: false
|
|
autoRevokeAllowed: false
|
|
recommendationsEnabled: false
|
|
modified: '2022-08-02T20:29:51.331Z'
|
|
filter:
|
|
type: CAMPAIGN_FILTER
|
|
id: 0fbe863c063c4c88a35fd7f17e8a3df5
|
|
name: Test Role Composition Filter
|
|
sunsetCommentsRequired: true
|
|
sourceOwnerCampaignInfo: null
|
|
searchCampaignInfo: null
|
|
roleCompositionCampaignInfo:
|
|
remediatorRef:
|
|
type: IDENTITY
|
|
id: 7ec252acbd4245548bc25df22348cb75
|
|
name: SailPoint Support
|
|
reviewerId: null
|
|
reviewer: null
|
|
roleIds:
|
|
- b15d609fc5c8434b865fe552315fda8f
|
|
query: null
|
|
description: null
|
|
sourcesWithOrphanEntitlements: null
|
|
mandatoryCommentRequirement: NO_DECISIONS
|
|
- id: 1be8fc1103914bf0a4e14e316b6a7b7c
|
|
name: Manager Review
|
|
description: A review of everyone's access by their manager.
|
|
deadline: '2020-12-25T06:00:00.468Z'
|
|
type: MANAGER
|
|
status: STAGED
|
|
emailNotificationEnabled: false
|
|
autoRevokeAllowed: false
|
|
recommendationsEnabled: false
|
|
modified: '2022-08-02T19:00:34.391Z'
|
|
filter:
|
|
type: CAMPAIGN_FILTER
|
|
id: 0fbe863c063c4c88a35fd7f17e8a3df5
|
|
name: Test Manager Filter
|
|
sunsetCommentsRequired: true
|
|
sourceOwnerCampaignInfo: null
|
|
searchCampaignInfo: null
|
|
roleCompositionCampaignInfo: null
|
|
sourcesWithOrphanEntitlements: []
|
|
mandatoryCommentRequirement: NO_DECISIONS
|
|
- id: 7e1a731e3fb845cfbe58112ba4673ee4
|
|
name: Search Campaign
|
|
description: Search Campaign for Identities
|
|
deadline: '2022-07-26T15:42:44.000Z'
|
|
type: SEARCH
|
|
status: ACTIVE
|
|
emailNotificationEnabled: false
|
|
autoRevokeAllowed: false
|
|
recommendationsEnabled: false
|
|
modified: '2022-07-25T15:42:53.718Z'
|
|
filter:
|
|
type: CAMPAIGN_FILTER
|
|
id: 0fbe863c063c4c88a35fd7f17e8a3df5
|
|
name: Test Search Filter
|
|
sunsetCommentsRequired: true
|
|
sourceOwnerCampaignInfo: null
|
|
searchCampaignInfo:
|
|
type: IDENTITY
|
|
description: Example of Search Campaign
|
|
reviewer:
|
|
type: IDENTITY
|
|
id: 7ec252acbd4245548bc25df22348cb75
|
|
name: null
|
|
query: user
|
|
identityIds: null
|
|
accessConstraints: []
|
|
roleCompositionCampaignInfo: null
|
|
sourcesWithOrphanEntitlements: []
|
|
mandatoryCommentRequirement: NO_DECISIONS
|
|
- id: ad3cf3dd50394b1bad646de4bc51b999
|
|
name: Source Owner Campaign
|
|
description: Example for Source Owner Campaign
|
|
deadline: '2022-08-10T17:09:02.000Z'
|
|
type: SOURCE_OWNER
|
|
status: ACTIVE
|
|
emailNotificationEnabled: true
|
|
autoRevokeAllowed: false
|
|
recommendationsEnabled: false
|
|
modified: '2022-07-27T17:09:13.925Z'
|
|
filter:
|
|
type: CAMPAIGN_FILTER
|
|
id: 0fbe863c063c4c88a35fd7f17e8a3df5
|
|
name: Test Source Owner Filter
|
|
sunsetCommentsRequired: true
|
|
sourceOwnerCampaignInfo:
|
|
sourceIds:
|
|
- 2c91808781fd5aea01821200dc88318e
|
|
searchCampaignInfo: null
|
|
roleCompositionCampaignInfo: null
|
|
sourcesWithOrphanEntitlements: []
|
|
correlatedStatus: CORRELATED
|
|
mandatoryCommentRequirement: NO_DECISIONS
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional)
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
$Filters = "name eq "Manager Campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **status**: *eq, in* (optional)
|
|
$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created** (optional)
|
|
|
|
# List Campaigns
|
|
|
|
try {
|
|
Get-ActiveCampaigns
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-ActiveCampaigns -Detail $Detail -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ActiveCampaigns"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
post:
|
|
operationId: createCampaign
|
|
tags:
|
|
- Certification Campaigns
|
|
summary: Create a campaign
|
|
description: |
|
|
Use this API to create a certification campaign with the information provided in the request body.
|
|
security:
|
|
- userAuth:
|
|
- idn:campaign:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- CERT_ADMIN
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1campaigns/get/responses/200/content/application~1json/schema/items/anyOf/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/Campaign.yaml
|
|
examples:
|
|
Manager:
|
|
value:
|
|
name: Manager Review
|
|
description: A review of everyone's access by their manager.
|
|
deadline: '2020-12-25T06:00:00.468Z'
|
|
type: MANAGER
|
|
emailNotificationEnabled: false
|
|
autoRevokeAllowed: false
|
|
recommendationsEnabled: false
|
|
filter:
|
|
type: CAMPAIGN_FILTER
|
|
id: 0c46fb26c6b20967a55517ee90d15b93
|
|
mandatoryCommentRequirement: NO_DECISIONS
|
|
Search:
|
|
value:
|
|
name: Search Campaign
|
|
description: Search Campaign
|
|
deadline: '2020-12-25T06:00:00.468Z'
|
|
type: SEARCH
|
|
emailNotificationEnabled: false
|
|
autoRevokeAllowed: false
|
|
recommendationsEnabled: false
|
|
filter:
|
|
type: CAMPAIGN_FILTER
|
|
id: 0c46fb26c6b20967a55517ee90d15b93
|
|
searchCampaignInfo:
|
|
type: ACCESS
|
|
query: user
|
|
mandatoryCommentRequirement: NO_DECISIONS
|
|
Source Owner:
|
|
value:
|
|
name: Source Owner
|
|
description: Source Owner Info
|
|
deadline: '2020-12-25T06:00:00.468Z'
|
|
type: SOURCE_OWNER
|
|
emailNotificationEnabled: false
|
|
autoRevokeAllowed: false
|
|
recommendationsEnabled: false
|
|
filter:
|
|
type: CAMPAIGN_FILTER
|
|
id: 0c46fb26c6b20967a55517ee90d15b93
|
|
sourceOwnerCampaignInfo:
|
|
sourceIds:
|
|
- 612b31b1a0f04aaf83123bdb80e70db6
|
|
correlatedStatus: CORRELATED
|
|
mandatoryCommentRequirement: NO_DECISIONS
|
|
Role Composition:
|
|
value:
|
|
name: Role Composition Campaign
|
|
description: A review done by a role owner.
|
|
deadline: '2020-12-25T06:00:00.468Z'
|
|
type: ROLE_COMPOSITION
|
|
emailNotificationEnabled: false
|
|
autoRevokeAllowed: false
|
|
recommendationsEnabled: false
|
|
filter:
|
|
type: CAMPAIGN_FILTER
|
|
id: 0c46fb26c6b20967a55517ee90d15b93
|
|
roleCompositionCampaignInfo:
|
|
remediatorRef:
|
|
type: IDENTITY
|
|
id: 7ec252acbd4245548bc25df22348cb75
|
|
name: SailPoint Support
|
|
roleIds:
|
|
- b15d609fc5c8434b865fe552315fda8f
|
|
mandatoryCommentRequirement: NO_DECISIONS
|
|
Machine Account:
|
|
value:
|
|
name: Machine Account Owner Campaign
|
|
description: A review done by a Machine Account's owner.
|
|
deadline: '2024-12-25T06:00:00.468Z'
|
|
type: MACHINE_ACCOUNT
|
|
emailNotificationEnabled: false
|
|
autoRevokeAllowed: false
|
|
recommendationsEnabled: false
|
|
filter:
|
|
type: CAMPAIGN_FILTER
|
|
id: 0c46fb26c6b20967a55517ee90d15b93
|
|
machineAccountCampaignInfo:
|
|
sourceIds:
|
|
- d988f117b7624a16ab0b64c439d5dbb8
|
|
reviewerType: ACCOUNT_OWNER
|
|
responses:
|
|
'200':
|
|
description: This response indicates that the requested campaign was successfully created, and the API returns its representation.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1campaigns/get/responses/200/content/application~1json/schema/items/anyOf/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/Campaign.yaml
|
|
examples:
|
|
Manager:
|
|
value:
|
|
id: 5594f43b76804a6980ece5fdccf74be7
|
|
name: Manager Review
|
|
description: A review of everyone's access by their manager.
|
|
deadline: '2020-12-25T06:00:00.468Z'
|
|
type: MANAGER
|
|
status: PENDING
|
|
emailNotificationEnabled: false
|
|
autoRevokeAllowed: false
|
|
recommendationsEnabled: false
|
|
created: '2022-08-02T20:21:18.421Z'
|
|
modified: null
|
|
filter:
|
|
type: CAMPAIGN_FILTER
|
|
id: 0fbe863c063c4c88a35fd7f17e8a3df5
|
|
name: Test Manager Filter
|
|
sunsetCommentsRequired: true
|
|
sourceOwnerCampaignInfo: null
|
|
searchCampaignInfo: null
|
|
roleCompositionCampaignInfo: null
|
|
machineAccountCampaignInfo: null
|
|
alerts: null
|
|
totalCertifications: 0
|
|
completedCertifications: 0
|
|
sourcesWithOrphanEntitlements: null
|
|
mandatoryCommentRequirement: NO_DECISIONS
|
|
Search:
|
|
value:
|
|
id: ec041831cb2147778b594feb9d8db44a
|
|
name: Search Campaign
|
|
description: Search Campaign
|
|
deadline: '2020-12-25T06:00:00.468Z'
|
|
type: SEARCH
|
|
status: PENDING
|
|
emailNotificationEnabled: false
|
|
autoRevokeAllowed: false
|
|
recommendationsEnabled: false
|
|
created: '2022-08-03T13:54:34.344Z'
|
|
modified: null
|
|
filter:
|
|
type: CAMPAIGN_FILTER
|
|
id: 0fbe863c063c4c88a35fd7f17e8a3df5
|
|
name: Test Search Filter
|
|
sunsetCommentsRequired: true
|
|
sourceOwnerCampaignInfo: null
|
|
searchCampaignInfo:
|
|
type: ACCESS
|
|
description: user
|
|
reviewer:
|
|
type: IDENTITY
|
|
id: 7ec252acbd4245548bc25df22348cb75
|
|
name: null
|
|
query: user
|
|
identityIds: null
|
|
accessConstraints: []
|
|
roleCompositionCampaignInfo: null
|
|
machineAccountCampaignInfo: null
|
|
alerts: null
|
|
totalCertifications: 0
|
|
completedCertifications: 0
|
|
sourcesWithOrphanEntitlements: null
|
|
mandatoryCommentRequirement: NO_DECISIONS
|
|
Source Owner:
|
|
value:
|
|
id: fd7b76ba4ea042de8a9414aa12fc977a
|
|
name: Source Owner
|
|
description: Source Owner Info
|
|
deadline: '2020-12-25T06:00:00.468Z'
|
|
type: SOURCE_OWNER
|
|
status: PENDING
|
|
emailNotificationEnabled: false
|
|
autoRevokeAllowed: false
|
|
recommendationsEnabled: false
|
|
created: '2022-08-03T13:34:19.541Z'
|
|
modified: null
|
|
filter:
|
|
type: CAMPAIGN_FILTER
|
|
id: 0fbe863c063c4c88a35fd7f17e8a3df5
|
|
name: Test Source Owner Filter
|
|
sunsetCommentsRequired: true
|
|
sourceOwnerCampaignInfo: null
|
|
sourceIds:
|
|
- 612b31b1a0f04aaf83123bdb80e70db6
|
|
searchCampaignInfo: null
|
|
roleCompositionCampaignInfo: null
|
|
machineAccountCampaignInfo: null
|
|
alerts: null
|
|
totalCertifications: 0
|
|
completedCertifications: 0
|
|
sourcesWithOrphanEntitlements: null
|
|
correlatedStatus: CORRELATED
|
|
mandatoryCommentRequirement: NO_DECISIONS
|
|
Role Composition:
|
|
value:
|
|
id: 3b2e2e5821e84127b6d693d41c40623b
|
|
name: Role Composition Campaign
|
|
description: A review done by a role owner.
|
|
deadline: '2020-12-25T06:00:00.468Z'
|
|
type: ROLE_COMPOSITION
|
|
status: PENDING
|
|
emailNotificationEnabled: false
|
|
autoRevokeAllowed: false
|
|
recommendationsEnabled: false
|
|
created: '2022-08-02T20:30:46.083Z'
|
|
modified: null
|
|
filter:
|
|
type: CAMPAIGN_FILTER
|
|
id: 0fbe863c063c4c88a35fd7f17e8a3df5
|
|
name: Test Role Composition Filter
|
|
sunsetCommentsRequired: true
|
|
sourceOwnerCampaignInfo: null
|
|
searchCampaignInfo: null
|
|
roleCompositionCampaignInfo:
|
|
remediatorRef:
|
|
type: IDENTITY
|
|
id: 7ec252acbd4245548bc25df22348cb75
|
|
name: SailPoint Support
|
|
reviewerId: null
|
|
reviewer: null
|
|
roleIds:
|
|
- b15d609fc5c8434b865fe552315fda8f
|
|
query: null
|
|
description: null
|
|
alerts: null
|
|
totalCertifications: 0
|
|
completedCertifications: 0
|
|
sourcesWithOrphanEntitlements: null
|
|
machineAccountCampaignInfo: null
|
|
mandatoryCommentRequirement: NO_DECISIONS
|
|
Machine Account Owner:
|
|
value:
|
|
id: 3e9ff3d6555e4721b74695d5b578e847
|
|
name: Machine Account Owner Campaign
|
|
description: A review done by a machine account's owner.
|
|
deadline: '2024-05-07T19:43:38.186Z'
|
|
type: MACHINE_ACCOUNT
|
|
status: PENDING
|
|
emailNotificationEnabled: false
|
|
autoRevokeAllowed: false
|
|
recommendationsEnabled: false
|
|
created: '2024-04-23T19:43:38.355Z'
|
|
modified: '2024-04-23T19:43:38.355Z'
|
|
filter: null
|
|
sunsetCommentsRequired: true
|
|
mandatoryCommentRequirement: NO_DECISIONS
|
|
sourceOwnerCampaignInfo: null
|
|
searchCampaignInfo: null
|
|
roleCompositionCampaignInfo: null
|
|
totalCertifications: 0
|
|
completedCertifications: 0
|
|
alerts: null
|
|
correlatedStatus: CORRELATED
|
|
sourcesWithOrphanEntitlements: []
|
|
machineAccountCampaignInfo:
|
|
sourceIds:
|
|
- d988f117b7624a16ab0b64c439d5dbb8
|
|
reviewerType: ACCOUNT_OWNER
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Campaign = @"
|
|
{
|
|
"totalCertifications" : 100,
|
|
"sourcesWithOrphanEntitlements" : [ {
|
|
"name" : "Source with orphan entitlements",
|
|
"id" : "2c90ad2a70ace7d50170acf22ca90010",
|
|
"type" : "SOURCE"
|
|
}, {
|
|
"name" : "Source with orphan entitlements",
|
|
"id" : "2c90ad2a70ace7d50170acf22ca90010",
|
|
"type" : "SOURCE"
|
|
} ],
|
|
"recommendationsEnabled" : true,
|
|
"sunsetCommentsRequired" : true,
|
|
"created" : "2020-03-03T22:15:13.611Z",
|
|
"machineAccountCampaignInfo" : {
|
|
"reviewerType" : "ACCOUNT_OWNER",
|
|
"sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ]
|
|
},
|
|
"description" : "Everyone needs to be reviewed by their manager",
|
|
"type" : "MANAGER",
|
|
"sourceOwnerCampaignInfo" : {
|
|
"sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ]
|
|
},
|
|
"emailNotificationEnabled" : false,
|
|
"alerts" : [ {
|
|
"level" : "ERROR",
|
|
"localizations" : [ {
|
|
"localeOrigin" : "DEFAULT",
|
|
"text" : "The request was syntactically correct but its content is semantically invalid.",
|
|
"locale" : "en-US"
|
|
}, {
|
|
"localeOrigin" : "DEFAULT",
|
|
"text" : "The request was syntactically correct but its content is semantically invalid.",
|
|
"locale" : "en-US"
|
|
} ]
|
|
}, {
|
|
"level" : "ERROR",
|
|
"localizations" : [ {
|
|
"localeOrigin" : "DEFAULT",
|
|
"text" : "The request was syntactically correct but its content is semantically invalid.",
|
|
"locale" : "en-US"
|
|
}, {
|
|
"localeOrigin" : "DEFAULT",
|
|
"text" : "The request was syntactically correct but its content is semantically invalid.",
|
|
"locale" : "en-US"
|
|
} ]
|
|
} ],
|
|
"filter" : {
|
|
"name" : "Test Filter",
|
|
"id" : "0fbe863c063c4c88a35fd7f17e8a3df5",
|
|
"type" : "CAMPAIGN_FILTER"
|
|
},
|
|
"searchCampaignInfo" : {
|
|
"identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ],
|
|
"query" : "Search Campaign query description",
|
|
"description" : "Search Campaign description",
|
|
"reviewer" : {
|
|
"name" : "William Wilson",
|
|
"id" : "2c91808568c529c60168cca6f90c1313",
|
|
"type" : "IDENTITY"
|
|
},
|
|
"type" : "ACCESS",
|
|
"accessConstraints" : [ {
|
|
"ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ],
|
|
"type" : "ENTITLEMENT",
|
|
"operator" : "SELECTED"
|
|
}, {
|
|
"ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ],
|
|
"type" : "ENTITLEMENT",
|
|
"operator" : "SELECTED"
|
|
}, {
|
|
"ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ],
|
|
"type" : "ENTITLEMENT",
|
|
"operator" : "SELECTED"
|
|
}, {
|
|
"ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ],
|
|
"type" : "ENTITLEMENT",
|
|
"operator" : "SELECTED"
|
|
}, {
|
|
"ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ],
|
|
"type" : "ENTITLEMENT",
|
|
"operator" : "SELECTED"
|
|
} ]
|
|
},
|
|
"autoRevokeAllowed" : false,
|
|
"name" : "Manager Campaign",
|
|
"mandatoryCommentRequirement" : "NO_DECISIONS",
|
|
"modified" : "2020-03-03T22:20:12.674Z",
|
|
"roleCompositionCampaignInfo" : {
|
|
"remediatorRef" : {
|
|
"name" : "Role Admin",
|
|
"id" : "2c90ad2a70ace7d50170acf22ca90010",
|
|
"type" : "IDENTITY"
|
|
},
|
|
"roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ],
|
|
"query" : "Search Query",
|
|
"description" : "Role Composition Description",
|
|
"reviewer" : {
|
|
"name" : "William Wilson",
|
|
"id" : "2c91808568c529c60168cca6f90c1313",
|
|
"type" : "IDENTITY"
|
|
}
|
|
},
|
|
"completedCertifications" : 10,
|
|
"id" : "2c9079b270a266a60170a2779fcb0007",
|
|
"deadline" : "2020-03-15T10:00:01.456Z",
|
|
"status" : "ACTIVE",
|
|
"correlatedStatus" : "CORRELATED"
|
|
}
|
|
"@
|
|
|
|
# Create a campaign
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToCampaign -Json $Campaign
|
|
New-Campaign-Campaign $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# New-Campaign -Campaign $Campaign
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Campaign"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/campaigns/{id}:
|
|
get:
|
|
operationId: getCampaign
|
|
tags:
|
|
- Certification Campaigns
|
|
summary: Get Campaign
|
|
description: |
|
|
Use this API to get information for an existing certification campaign by the campaign's ID.
|
|
security:
|
|
- userAuth:
|
|
- idn:campaign:read
|
|
- idn:campaign:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- CERT_ADMIN
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getActiveCampaigns
|
|
description: ID of the campaign to be retrieved.
|
|
example: 2c91808571bcfcf80171c23e4b4221fc
|
|
- in: query
|
|
name: detail
|
|
schema:
|
|
type: string
|
|
enum:
|
|
- SLIM
|
|
- FULL
|
|
required: false
|
|
description: Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior.
|
|
example: FULL
|
|
responses:
|
|
'200':
|
|
description: Requested campaign object.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
anyOf:
|
|
- $ref: '#/paths/~1campaigns/get/responses/200/content/application~1json/schema/items/anyOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/SlimCampaign.yaml
|
|
- $ref: '#/paths/~1campaigns/get/responses/200/content/application~1json/schema/items/anyOf/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/Campaign.yaml
|
|
examples:
|
|
Manager:
|
|
value:
|
|
id: 2c918086719eec070171a7e3355a360a
|
|
name: Manager Review
|
|
description: A review of everyone's access by their manager.
|
|
deadline: '2020-12-25T06:00:00.123Z'
|
|
type: MANAGER
|
|
status: ACTIVE
|
|
emailNotificationEnabled: false
|
|
autoRevokeAllowed: false
|
|
recommendationsEnabled: false
|
|
Search:
|
|
value:
|
|
id: 7e1a731e3fb845cfbe58112ba4673ee4
|
|
name: Search Campaign
|
|
description: Search Campaign Info
|
|
deadline: '2022-07-26T15:42:44.000Z'
|
|
type: SEARCH
|
|
status: ACTIVE
|
|
emailNotificationEnabled: false
|
|
autoRevokeAllowed: false
|
|
recommendationsEnabled: false
|
|
Source Owner:
|
|
value:
|
|
id: 2c918086719eec070171a7e3355a412b
|
|
name: AD Source Review
|
|
description: A review of our AD source.
|
|
deadline: '2020-12-25T06:00:00.123Z'
|
|
type: SOURCE_OWNER
|
|
status: STAGED
|
|
emailNotificationEnabled: true
|
|
autoRevokeAllowed: false
|
|
recommendationsEnabled: false
|
|
correlatedStatus: CORRELATED
|
|
RoleComposition:
|
|
value:
|
|
id: 3b2e2e5821e84127b6d693d41c40623b
|
|
name: Role Composition Campaign
|
|
description: A review done by a role owner.
|
|
deadline: '2020-12-25T06:00:00.468Z'
|
|
type: ROLE_COMPOSITION
|
|
status: ACTIVE
|
|
emailNotificationEnabled: false
|
|
autoRevokeAllowed: false
|
|
recommendationsEnabled: false
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign to be retrieved.
|
|
$Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional)
|
|
|
|
# Get Campaign
|
|
|
|
try {
|
|
Get-Campaign-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-Campaign -Id $Id -Detail $Detail
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Campaign"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
patch:
|
|
operationId: updateCampaign
|
|
tags:
|
|
- Certification Campaigns
|
|
summary: Update a Campaign
|
|
description: |
|
|
Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
security:
|
|
- userAuth:
|
|
- idn:campaign:read
|
|
- idn:campaign:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- CERT_ADMIN
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getActiveCampaigns
|
|
description: ID of the campaign template being modified.
|
|
example: 2c91808571bcfcf80171c23e4b4221fc
|
|
requestBody:
|
|
required: true
|
|
description: |
|
|
A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
The fields that can be patched differ based on the status of the campaign.
|
|
|
|
When the campaign is in the *STAGED* status, you can patch these fields:
|
|
* name
|
|
* description
|
|
* recommendationsEnabled
|
|
* deadline
|
|
* emailNotificationEnabled
|
|
* autoRevokeAllowed
|
|
|
|
When the campaign is in the *ACTIVE* status, you can patch these fields:
|
|
* deadline
|
|
content:
|
|
application/json-patch+json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/JsonPatchOperation.yaml
|
|
example:
|
|
- op: replace
|
|
path: /name
|
|
value: This field has been updated!
|
|
- op: copy
|
|
from: /name
|
|
path: /description
|
|
responses:
|
|
'200':
|
|
description: This response indicates that the PATCH operation succeeded, and the API returns the campaign's new representation.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1campaigns/get/responses/200/content/application~1json/schema/items/anyOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/SlimCampaign.yaml
|
|
examples:
|
|
Manager:
|
|
$ref: '#/paths/~1campaigns~1%7Bid%7D/get/responses/200/content/application~1json/examples/Manager'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/campaign/examples/SlimCampaignManager.yaml
|
|
Search:
|
|
$ref: '#/paths/~1campaigns~1%7Bid%7D/get/responses/200/content/application~1json/examples/Search'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/campaign/examples/SlimCampaignSearch.yaml
|
|
Source Owner:
|
|
$ref: '#/paths/~1campaigns~1%7Bid%7D/get/responses/200/content/application~1json/examples/Source%20Owner'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/campaign/examples/SlimCampaignSourceOwner.yaml
|
|
RoleComposition:
|
|
$ref: '#/paths/~1campaigns~1%7Bid%7D/get/responses/200/content/application~1json/examples/RoleComposition'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/campaign/examples/SlimCampaignRoleComposition.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign template being modified.
|
|
# JsonPatchOperation[] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline
|
|
$JsonPatchOperation = @"{
|
|
"op" : "replace",
|
|
"path" : "/description",
|
|
"value" : "New description"
|
|
}"@
|
|
|
|
|
|
# Update a Campaign
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
|
|
Update-Campaign-Id $Id -JsonPatchOperation $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Update-Campaign -Id $Id -JsonPatchOperation $JsonPatchOperation
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Campaign"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/campaigns/{id}/reassign:
|
|
post:
|
|
security:
|
|
- userAuth:
|
|
- idn:campaign:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- CERT_ADMIN
|
|
operationId: move
|
|
tags:
|
|
- Certification Campaigns
|
|
summary: Reassign Certifications
|
|
description: |
|
|
This API reassigns the specified certifications from one identity to another.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getActiveCampaigns
|
|
description: The certification campaign ID
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
certificationIds:
|
|
description: List of certification IDs to reassign
|
|
type: array
|
|
items:
|
|
type: string
|
|
minItems: 1
|
|
maxItems: 250
|
|
example:
|
|
- af3859464779471211bb8424a563abc1
|
|
- af3859464779471211bb8424a563abc2
|
|
- af3859464779471211bb8424a563abc3
|
|
reassignTo:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The identity ID to which the review is being assigned.
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
type:
|
|
type: string
|
|
description: The type of the ID provided.
|
|
enum:
|
|
- IDENTITY
|
|
example: IDENTITY
|
|
reason:
|
|
type: string
|
|
description: Comment to explain why the certification was reassigned
|
|
example: reassigned for some reason
|
|
responses:
|
|
'202':
|
|
description: The reassign task that has been submitted.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The ID of the certification task.
|
|
example: 2c918086719eec070171a7e3355a360a
|
|
type:
|
|
type: string
|
|
description: The type of the certification task. More values may be added in the future.
|
|
enum:
|
|
- REASSIGN
|
|
- ADMIN_REASSIGN
|
|
- COMPLETE_CERTIFICATION
|
|
- FINISH_CERTIFICATION
|
|
- COMPLETE_CAMPAIGN
|
|
- ACTIVATE_CAMPAIGN
|
|
- CAMPAIGN_CREATE
|
|
- CAMPAIGN_DELETE
|
|
example: ADMIN_REASSIGN
|
|
targetType:
|
|
type: string
|
|
description: The type of item that is being operated on by this task whose ID is stored in the targetId field.
|
|
enum:
|
|
- CERTIFICATION
|
|
- CAMPAIGN
|
|
example: CAMPAIGN
|
|
targetId:
|
|
type: string
|
|
description: The ID of the item being operated on by this task.
|
|
example: 2c918086719eec070171a7e3355a834c
|
|
status:
|
|
type: string
|
|
description: The status of the task.
|
|
enum:
|
|
- QUEUED
|
|
- IN_PROGRESS
|
|
- SUCCESS
|
|
- ERROR
|
|
example: QUEUED
|
|
errors:
|
|
$ref: '#/paths/~1access-request-status/get/responses/200/content/application~1json/schema/items/properties/errorMessages/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ErrorMessageDtoList.yaml
|
|
reassignmentTrailDTOs:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
previousOwner:
|
|
type: string
|
|
description: The ID of previous owner identity.
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
newOwner:
|
|
type: string
|
|
description: The ID of new owner identity.
|
|
example: ef38f94347e94562b5bb8424a56397a3
|
|
reassignmentType:
|
|
type: string
|
|
description: The type of reassignment.
|
|
example: AUTOMATIC_REASSIGNMENT
|
|
description: Reassignment trails that lead to self certification identity
|
|
example:
|
|
previousOwner: ef38f94347e94562b5bb8424a56397d8
|
|
newOwner: ef38f94347e94562b5bb8424a56397a3
|
|
reassignmentType: AUTOMATIC_REASSIGNMENT
|
|
created:
|
|
type: string
|
|
description: The date and time on which this task was created.
|
|
format: date-time
|
|
example: '2020-09-24T18:10:47.693Z'
|
|
example:
|
|
id: 2c918086719eec070171a7e3355a360a
|
|
type: ADMIN_REASSIGN
|
|
targetType: CAMPAIGN
|
|
targetId: 2c918086719eec070171a7e3355a834c
|
|
status: QUEUED
|
|
errors: []
|
|
created: '2020-09-24T18:10:47.693Z'
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification campaign ID
|
|
$AdminReviewReassign = @"
|
|
{
|
|
"certificationIds" : [ "af3859464779471211bb8424a563abc1", "af3859464779471211bb8424a563abc2", "af3859464779471211bb8424a563abc3" ],
|
|
"reason" : "reassigned for some reason",
|
|
"reassignTo" : {
|
|
"id" : "ef38f94347e94562b5bb8424a56397d8",
|
|
"type" : "IDENTITY"
|
|
}
|
|
}
|
|
"@
|
|
|
|
# Reassign Certifications
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign
|
|
Move--Id $Id -AdminReviewReassign $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Move- -Id $Id -AdminReviewReassign $AdminReviewReassign
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Move-"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/campaigns/{id}/activate:
|
|
post:
|
|
operationId: startCampaign
|
|
tags:
|
|
- Certification Campaigns
|
|
summary: Activate a Campaign
|
|
description: |
|
|
Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged.
|
|
security:
|
|
- userAuth:
|
|
- idn:campaign:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- CERT_ADMIN
|
|
requestBody:
|
|
description: Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller's timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format.
|
|
required: false
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
timeZone:
|
|
type: string
|
|
description: The timezone must be in a valid ISO 8601 format. Timezones in ISO 8601 are represented as UTC (represented as 'Z') or as an offset from UTC. The offset format can be +/-hh:mm, +/-hhmm, or +/-hh.
|
|
default: Z
|
|
example: '-05:00'
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getActiveCampaigns
|
|
description: Campaign ID.
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
responses:
|
|
'202':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/202'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/202.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID.
|
|
$ActivateCampaignOptions = @"
|
|
{
|
|
"timeZone" : "-05:00"
|
|
}
|
|
"@
|
|
|
|
# Activate a Campaign
|
|
|
|
try {
|
|
Start-Campaign-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Start-Campaign -Id $Id -ActivateCampaignOptions $ActivateCampaignOptions
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-Campaign"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/campaigns/{id}/complete:
|
|
post:
|
|
operationId: completeCampaign
|
|
tags:
|
|
- Certification Campaigns
|
|
summary: Complete a Campaign
|
|
description: |
|
|
:::caution
|
|
|
|
This endpoint will run successfully for any campaigns that are **past due**.
|
|
|
|
This endpoint will return a content error if the campaign is **not past due**.
|
|
|
|
:::
|
|
|
|
Use this API to complete a certification campaign. This functionality is provided to admins so that they
|
|
can complete a certification even if all items have not been completed.
|
|
security:
|
|
- userAuth:
|
|
- idn:campaign:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- CERT_ADMIN
|
|
requestBody:
|
|
description: Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE
|
|
required: false
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
autoCompleteAction:
|
|
description: Determines whether to auto-approve(APPROVE) or auto-revoke(REVOKE) upon campaign completion.
|
|
type: string
|
|
enum:
|
|
- APPROVE
|
|
- REVOKE
|
|
default: APPROVE
|
|
example: REVOKE
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getActiveCampaigns
|
|
description: Campaign ID.
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
responses:
|
|
'202':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/202'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/202.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID.
|
|
$CampaignCompleteOptions = @"
|
|
{
|
|
"autoCompleteAction" : "REVOKE"
|
|
}
|
|
"@
|
|
|
|
# Complete a Campaign
|
|
|
|
try {
|
|
Complete-Campaign-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Complete-Campaign -Id $Id -CampaignCompleteOptions $CampaignCompleteOptions
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-Campaign"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/campaigns/delete:
|
|
post:
|
|
operationId: deleteCampaigns
|
|
tags:
|
|
- Certification Campaigns
|
|
summary: Delete Campaigns
|
|
description: |
|
|
Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs.
|
|
security:
|
|
- userAuth:
|
|
- idn:campaign:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- CERT_ADMIN
|
|
requestBody:
|
|
description: IDs of the campaigns to delete.
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
ids:
|
|
description: The ids of the campaigns to delete
|
|
type: array
|
|
items:
|
|
type: string
|
|
example:
|
|
- 2c9180887335cee10173490db1776c26
|
|
- 2c9180836a712436016a7125a90c0021
|
|
responses:
|
|
'202':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/202'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/202.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$CampaignsDeleteRequest = @"
|
|
{
|
|
"ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ]
|
|
}
|
|
"@
|
|
|
|
# Delete Campaigns
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToCampaignsDeleteRequest -Json $CampaignsDeleteRequest
|
|
Remove-Campaigns-CampaignsDeleteRequest $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Remove-Campaigns -CampaignsDeleteRequest $CampaignsDeleteRequest
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Campaigns"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/campaigns/{id}/run-remediation-scan:
|
|
post:
|
|
operationId: startCampaignRemediationScan
|
|
tags:
|
|
- Certification Campaigns
|
|
summary: Run Campaign Remediation Scan
|
|
description: |
|
|
Use this API to run a remediation scan task for a certification campaign.
|
|
security:
|
|
- userAuth:
|
|
- idn:campaign-report:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- CERT_ADMIN
|
|
- REPORT_ADMIN
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
example: 2c91808571bcfcf80171c23e4b4221fc
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getActiveCampaigns
|
|
description: ID of the campaign the remediation scan is being run for.
|
|
responses:
|
|
'202':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/202'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/202.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the remediation scan is being run for.
|
|
|
|
# Run Campaign Remediation Scan
|
|
|
|
try {
|
|
Start-CampaignRemediationScan-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Start-CampaignRemediationScan -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-CampaignRemediationScan"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/campaigns/{id}/reports:
|
|
get:
|
|
operationId: getCampaignReports
|
|
tags:
|
|
- Certification Campaigns
|
|
summary: Get Campaign Reports
|
|
description: |
|
|
Use this API to fetch all reports for a certification campaign by campaign ID.
|
|
security:
|
|
- userAuth:
|
|
- idn:campaign-report:read
|
|
- idn:campaign-report:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- CERT_ADMIN
|
|
- REPORT_ADMIN
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
example: 2c91808571bcfcf80171c23e4b4221fc
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getActiveCampaigns
|
|
description: ID of the campaign whose reports are being fetched.
|
|
responses:
|
|
'200':
|
|
description: Array of campaign report objects.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
title: Campaign Report
|
|
required:
|
|
- reportType
|
|
allOf:
|
|
- $ref: '#/paths/~1sod-policies~1%7Bid%7D~1evaluate/post/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ReportResultReference.yaml
|
|
- type: object
|
|
properties:
|
|
reportType:
|
|
$ref: '#/paths/~1campaigns~1%7Bid%7D~1run-report~1%7Btype%7D/post/parameters/1/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ReportType.yaml
|
|
lastRunAt:
|
|
type: string
|
|
readOnly: true
|
|
format: date-time
|
|
description: The most recent date and time this report was run
|
|
example:
|
|
type: REPORT_RESULT
|
|
id: 2c91808568c529c60168cca6f90c1313
|
|
name: Campaign Composition Report
|
|
status: SUCCESS
|
|
reportType: CAMPAIGN_COMPOSITION_REPORT
|
|
lastRunAt: '2019-12-19T13:49:37.385Z'
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign whose reports are being fetched.
|
|
|
|
# Get Campaign Reports
|
|
|
|
try {
|
|
Get-CampaignReports-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-CampaignReports -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignReports"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/campaigns/{id}/run-report/{type}:
|
|
post:
|
|
operationId: startCampaignReport
|
|
tags:
|
|
- Certification Campaigns
|
|
summary: Run Campaign Report
|
|
description: |
|
|
Use this API to run a report for a certification campaign.
|
|
security:
|
|
- userAuth:
|
|
- idn:campaign-report:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- CERT_ADMIN
|
|
- REPORT_ADMIN
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
example: 2c91808571bcfcf80171c23e4b4221fc
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getActiveCampaigns
|
|
description: ID of the campaign the report is being run for.
|
|
- in: path
|
|
name: type
|
|
schema:
|
|
type: string
|
|
description: type of a Report
|
|
enum:
|
|
- CAMPAIGN_COMPOSITION_REPORT
|
|
- CAMPAIGN_REMEDIATION_STATUS_REPORT
|
|
- CAMPAIGN_STATUS_REPORT
|
|
- CERTIFICATION_SIGNOFF_REPORT
|
|
example: CAMPAIGN_COMPOSITION_REPORT
|
|
required: true
|
|
description: Type of the report to run.
|
|
responses:
|
|
'202':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/202'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/202.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the report is being run for.
|
|
$Type = "CAMPAIGN_COMPOSITION_REPORT" # ReportType | Type of the report to run.
|
|
|
|
# Run Campaign Report
|
|
|
|
try {
|
|
Start-CampaignReport-Id $Id -Type $Type
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Start-CampaignReport -Id $Id -Type $Type
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-CampaignReport"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/campaigns/reports-configuration:
|
|
get:
|
|
operationId: getCampaignReportsConfig
|
|
tags:
|
|
- Certification Campaigns
|
|
summary: Get Campaign Reports Configuration
|
|
description: |
|
|
Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns.
|
|
security:
|
|
- userAuth:
|
|
- idn:campaign:read
|
|
- idn:campaign:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- CERT_ADMIN
|
|
responses:
|
|
'200':
|
|
description: Campaign report configuration.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: Campaign Reports Configuration
|
|
properties:
|
|
identityAttributeColumns:
|
|
type: array
|
|
nullable: true
|
|
description: list of identity attribute columns
|
|
items:
|
|
type: string
|
|
example:
|
|
- firstname
|
|
- lastname
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
|
|
# Get Campaign Reports Configuration
|
|
|
|
try {
|
|
Get-CampaignReportsConfig
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-CampaignReportsConfig
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignReportsConfig"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
put:
|
|
operationId: setCampaignReportsConfig
|
|
tags:
|
|
- Certification Campaigns
|
|
summary: Set Campaign Reports Configuration
|
|
description: |
|
|
Use this API to overwrite the configuration for campaign reports.
|
|
security:
|
|
- userAuth:
|
|
- idn:campaign:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- CERT_ADMIN
|
|
requestBody:
|
|
required: true
|
|
description: Campaign report configuration.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1campaigns~1reports-configuration/get/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/CampaignReportsConfig.yaml
|
|
responses:
|
|
'200':
|
|
description: The persisted campaign report configuration.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1campaigns~1reports-configuration/get/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/CampaignReportsConfig.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$CampaignReportsConfig = @"
|
|
{
|
|
"identityAttributeColumns" : [ "firstname", "lastname" ]
|
|
}
|
|
"@
|
|
|
|
# Set Campaign Reports Configuration
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig
|
|
Set-CampaignReportsConfig-CampaignReportsConfig $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Set-CampaignReportsConfig -CampaignReportsConfig $CampaignReportsConfig
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-CampaignReportsConfig"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/campaign-filters:
|
|
post:
|
|
operationId: createCampaignFilter
|
|
tags:
|
|
- Certification Campaign Filters
|
|
summary: Create Campaign Filter
|
|
description: Use this API to create a campaign filter based on filter details and criteria.
|
|
security:
|
|
- userAuth:
|
|
- idn:campaign-filter:create
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
description: Campaign Filter Details
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The unique ID of the campaign filter
|
|
example: 5ec18cef39020d6fd7a60ad3970aba61
|
|
name:
|
|
type: string
|
|
description: Campaign filter name.
|
|
example: Identity Attribute Campaign Filter
|
|
description:
|
|
type: string
|
|
description: Campaign filter description.
|
|
example: Campaign filter to certify data based on an identity attribute's specified property.
|
|
owner:
|
|
type: string
|
|
description: Owner of the filter. This field automatically populates at creation time with the current user.
|
|
example: SailPoint Support
|
|
nullable: true
|
|
mode:
|
|
description: Mode/type of filter, either the INCLUSION or EXCLUSION type. The INCLUSION type includes the data in generated campaigns as per specified in the criteria, whereas the EXCLUSION type excludes the data in generated campaigns as per specified in criteria.
|
|
enum:
|
|
- INCLUSION
|
|
- EXCLUSION
|
|
example: INCLUSION
|
|
criteriaList:
|
|
type: array
|
|
description: List of criteria.
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
enum:
|
|
- COMPOSITE
|
|
- ROLE
|
|
- IDENTITY
|
|
- IDENTITY_ATTRIBUTE
|
|
- ENTITLEMENT
|
|
- ACCESS_PROFILE
|
|
- SOURCE
|
|
- ACCOUNT
|
|
- AGGREGATED_ENTITLEMENT
|
|
- INVALID_CERTIFIABLE_ENTITY
|
|
description: Type of the criteria in the filter. The `COMPOSITE` filter can contain multiple filters in an AND/OR relationship.
|
|
example: IDENTITY_ATTRIBUTE
|
|
operation:
|
|
allOf:
|
|
- type: string
|
|
enum:
|
|
- EQUALS
|
|
- NOT_EQUALS
|
|
- CONTAINS
|
|
- STARTS_WITH
|
|
- ENDS_WITH
|
|
- AND
|
|
- OR
|
|
- null
|
|
description: Operation on a specific criteria
|
|
example: EQUALS
|
|
- nullable: true
|
|
property:
|
|
type: string
|
|
description: Specified key from the type of criteria.
|
|
example: displayName
|
|
nullable: true
|
|
value:
|
|
type: string
|
|
description: Value for the specified key from the type of criteria.
|
|
example: Allie
|
|
nullable: true
|
|
required:
|
|
- type
|
|
- property
|
|
- value
|
|
- operation
|
|
example:
|
|
- type: IDENTITY_ATTRIBUTE
|
|
property: displayName
|
|
value: support
|
|
operation: CONTAINS
|
|
negateResult: false
|
|
shortCircuit: false
|
|
recordChildMatches: false
|
|
id: null
|
|
suppressMatchedItems: false
|
|
children: null
|
|
isSystemFilter:
|
|
type: boolean
|
|
default: false
|
|
description: If true, the filter is created by the system. If false, the filter is created by a user.
|
|
example: false
|
|
required:
|
|
- id
|
|
- name
|
|
- owner
|
|
- mode
|
|
- isSystemFilter
|
|
responses:
|
|
'200':
|
|
description: Created successfully.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1campaign-filters/post/requestBody/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/CampaignFilterDetails.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$CampaignFilterDetails = @"
|
|
{
|
|
"owner" : "SailPoint Support",
|
|
"mode" : "INCLUSION",
|
|
"isSystemFilter" : false,
|
|
"name" : "Identity Attribute Campaign Filter",
|
|
"description" : "Campaign filter to certify data based on an identity attribute's specified property.",
|
|
"id" : "5ec18cef39020d6fd7a60ad3970aba61",
|
|
"criteriaList" : [ {
|
|
"type" : "IDENTITY_ATTRIBUTE",
|
|
"property" : "displayName",
|
|
"value" : "support",
|
|
"operation" : "CONTAINS",
|
|
"negateResult" : false,
|
|
"shortCircuit" : false,
|
|
"recordChildMatches" : false,
|
|
"suppressMatchedItems" : false
|
|
} ]
|
|
}
|
|
"@
|
|
|
|
# Create Campaign Filter
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails
|
|
New-CampaignFilter-CampaignFilterDetails $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# New-CampaignFilter -CampaignFilterDetails $CampaignFilterDetails
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-CampaignFilter"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
get:
|
|
operationId: listCampaignFilters
|
|
tags:
|
|
- Certification Campaign Filters
|
|
summary: List Campaign Filters
|
|
description: Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters.
|
|
security:
|
|
- userAuth:
|
|
- idn:campaign-filter-list:read
|
|
parameters:
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- in: query
|
|
name: start
|
|
description: Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
required: false
|
|
example: 0
|
|
schema:
|
|
type: integer
|
|
format: int32
|
|
minimum: 0
|
|
default: 0
|
|
- in: query
|
|
name: includeSystemFilters
|
|
description: 'If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. '
|
|
required: false
|
|
example: true
|
|
schema:
|
|
type: boolean
|
|
default: true
|
|
responses:
|
|
'200':
|
|
description: List of campaign filter objects.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
items:
|
|
type: array
|
|
description: List of campaign filters.
|
|
items:
|
|
$ref: '#/paths/~1campaign-filters/post/requestBody/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/CampaignFilterDetails.yaml
|
|
count:
|
|
type: integer
|
|
description: Number of filters returned.
|
|
example: 2
|
|
example:
|
|
items:
|
|
- id: 5b8a2ba86393dd174495c4436dd76b25
|
|
name: IdentityAttribute Inclusion Campaign Filter
|
|
description: IdentityAttribute Inclusion Campaign Filter
|
|
owner: SailPoint Support
|
|
mode: INCLUSION
|
|
criteriaList:
|
|
- type: IDENTITY_ATTRIBUTE
|
|
property: displayName
|
|
value: '#'
|
|
operation: CONTAINS
|
|
negateResult: false
|
|
shortCircuit: false
|
|
recordChildMatches: false
|
|
id: null
|
|
suppressMatchedItems: false
|
|
children: null
|
|
isSystemFilter: false
|
|
- id: e9f9a1397b842fd5a65842087040d3ac
|
|
name: Exclusion Campaign Filter
|
|
description: Campaign filter for Exclusion update
|
|
owner: SailPoint Support
|
|
mode: EXCLUSION
|
|
criteriaList:
|
|
- type: IDENTITY_ATTRIBUTE
|
|
property: displayName
|
|
value: '#@'
|
|
operation: CONTAINS
|
|
negateResult: false
|
|
shortCircuit: false
|
|
recordChildMatches: false
|
|
id: null
|
|
suppressMatchedItems: false
|
|
children: null
|
|
isSystemFilter: false
|
|
count: 2
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Start = 0 # Int32 | Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$IncludeSystemFilters = $true # Boolean | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to $true)
|
|
|
|
# List Campaign Filters
|
|
|
|
try {
|
|
Get-CampaignFilters
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-CampaignFilters -Limit $Limit -Start $Start -IncludeSystemFilters $IncludeSystemFilters
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignFilters"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/campaign-filters/{id}:
|
|
get:
|
|
operationId: getCampaignFilterById
|
|
tags:
|
|
- Certification Campaign Filters
|
|
summary: Get Campaign Filter by ID
|
|
description: Retrieves information for an existing campaign filter using the filter's ID.
|
|
security:
|
|
- userAuth:
|
|
- idn:campaign-filter:read
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
example: e9f9a1397b842fd5a65842087040d3ac
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listCampaignFilters
|
|
description: The ID of the campaign filter to be retrieved.
|
|
responses:
|
|
'200':
|
|
description: A campaign filter object.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1campaign-filters/post/requestBody/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/CampaignFilterDetails.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filter to be retrieved.
|
|
|
|
# Get Campaign Filter by ID
|
|
|
|
try {
|
|
Get-CampaignFilterById-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-CampaignFilterById -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignFilterById"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
post:
|
|
operationId: updateCampaignFilter
|
|
tags:
|
|
- Certification Campaign Filters
|
|
summary: Updates a Campaign Filter
|
|
description: Updates an existing campaign filter using the filter's ID.
|
|
security:
|
|
- userAuth:
|
|
- idn:campaign-filter:update
|
|
parameters:
|
|
- in: path
|
|
name: filterId
|
|
schema:
|
|
type: string
|
|
example: e9f9a1397b842fd5a65842087040d3ac
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listCampaignFilters
|
|
description: The ID of the campaign filter being modified.
|
|
requestBody:
|
|
required: true
|
|
description: A campaign filter details with updated field values.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1campaign-filters/post/requestBody/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/CampaignFilterDetails.yaml
|
|
responses:
|
|
'200':
|
|
description: Created successfully.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1campaign-filters/post/requestBody/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/CampaignFilterDetails.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$FilterId = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filter being modified.
|
|
$CampaignFilterDetails = @"
|
|
{
|
|
"owner" : "SailPoint Support",
|
|
"mode" : "INCLUSION",
|
|
"isSystemFilter" : false,
|
|
"name" : "Identity Attribute Campaign Filter",
|
|
"description" : "Campaign filter to certify data based on an identity attribute's specified property.",
|
|
"id" : "5ec18cef39020d6fd7a60ad3970aba61",
|
|
"criteriaList" : [ {
|
|
"type" : "IDENTITY_ATTRIBUTE",
|
|
"property" : "displayName",
|
|
"value" : "support",
|
|
"operation" : "CONTAINS",
|
|
"negateResult" : false,
|
|
"shortCircuit" : false,
|
|
"recordChildMatches" : false,
|
|
"suppressMatchedItems" : false
|
|
} ]
|
|
}
|
|
"@
|
|
|
|
# Updates a Campaign Filter
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails
|
|
Update-CampaignFilter-FilterId $FilterId -CampaignFilterDetails $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Update-CampaignFilter -FilterId $FilterId -CampaignFilterDetails $CampaignFilterDetails
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-CampaignFilter"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/campaign-filters/delete:
|
|
post:
|
|
operationId: deleteCampaignFilters
|
|
tags:
|
|
- Certification Campaign Filters
|
|
summary: Deletes Campaign Filters
|
|
description: Deletes campaign filters whose Ids are specified in the provided list of campaign filter Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN.
|
|
security:
|
|
- userAuth:
|
|
- idn:campaign-filter:delete
|
|
requestBody:
|
|
description: A json list of IDs of campaign filters to delete.
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
example:
|
|
- 0fbe863c063c4c88a35fd7f17e8a3df5
|
|
- 2efb374d392c4d88a34sv7b11e8a4eq6
|
|
responses:
|
|
'204':
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/204.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$RequestBody = "MyRequestBody" # String[] | A json list of IDs of campaign filters to delete.
|
|
$RequestBody = @""@
|
|
|
|
|
|
# Deletes Campaign Filters
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
|
|
Remove-CampaignFilters-RequestBody $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Remove-CampaignFilters -RequestBody $RequestBody
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-CampaignFilters"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/campaign-templates:
|
|
post:
|
|
operationId: createCampaignTemplate
|
|
tags:
|
|
- Certification Campaigns
|
|
summary: Create a Campaign Template
|
|
description: |
|
|
Use this API to create a certification campaign template based on campaign.
|
|
security:
|
|
- userAuth:
|
|
- idn:campaign-template:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- CERT_ADMIN
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
description: Campaign Template
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: Id of the campaign template
|
|
example: 2c9079b270a266a60170a277bb960008
|
|
name:
|
|
type: string
|
|
description: This template's name. Has no bearing on generated campaigns' names.
|
|
example: Manager Campaign Template
|
|
description:
|
|
type: string
|
|
description: This template's description. Has no bearing on generated campaigns' descriptions.
|
|
example: Template for the annual manager campaign.
|
|
created:
|
|
type: string
|
|
description: Creation date of Campaign Template
|
|
readOnly: true
|
|
format: date-time
|
|
example: '2020-03-05T22:44:00.364Z'
|
|
modified:
|
|
type: string
|
|
nullable: true
|
|
description: Modification date of Campaign Template
|
|
readOnly: true
|
|
format: date-time
|
|
example: '2020-03-05T22:52:09.969Z'
|
|
scheduled:
|
|
type: boolean
|
|
readOnly: true
|
|
description: Indicates if this campaign template has been scheduled.
|
|
example: false
|
|
default: false
|
|
ownerRef:
|
|
type: object
|
|
readOnly: true
|
|
description: The owner of this template, and the owner of campaigns generated from this template via a schedule. This field is automatically populated at creation time with the current user.
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: Id of the owner
|
|
example: 2c918086676d3e0601677611dbde220f
|
|
type:
|
|
type: string
|
|
enum:
|
|
- IDENTITY
|
|
description: Type of the owner
|
|
example: IDENTITY
|
|
name:
|
|
type: string
|
|
description: Name of the owner
|
|
example: Mister Manager
|
|
email:
|
|
type: string
|
|
description: Email of the owner
|
|
example: mr.manager@example.com
|
|
deadlineDuration:
|
|
type: string
|
|
description: The time period during which the campaign should be completed, formatted as an ISO-8601 Duration. When this template generates a campaign, the campaign's deadline will be the current date plus this duration. For example, if generation occurred on 2020-01-01 and this field was "P2W" (two weeks), the resulting campaign's deadline would be 2020-01-15 (the current date plus 14 days).
|
|
example: P2W
|
|
campaign:
|
|
$ref: '#/paths/~1campaigns/get/responses/200/content/application~1json/schema/items/anyOf/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/Campaign.yaml
|
|
required:
|
|
- name
|
|
- description
|
|
- created
|
|
- modified
|
|
- campaign
|
|
examples:
|
|
Manager:
|
|
description: This creates a template that can be used to generate manager campaigns. The campaigns will have a due date that is two weeks after their creation date, and will be named "{current date} Manager Review" (e.g. "2020-03-16 Manager Review").
|
|
value:
|
|
name: Manager Review
|
|
description: A review of everyone's access by their manager.
|
|
deadlineDuration: P2W
|
|
campaign:
|
|
name: Manager Review
|
|
description: Review everyone's access.
|
|
type: MANAGER
|
|
filter:
|
|
type: CAMPAIGN_FILTER
|
|
id: e0adaae69852e8fe8b8a3d48e5ce757c
|
|
emailNotificationEnabled: true
|
|
autoRevokeAllowed: false
|
|
recommendationsEnabled: false
|
|
mandatoryCommentRequirement: NO_DECISIONS
|
|
Search:
|
|
description: This creates a template that can be used to generate search access campaigns. The campaigns will cover the "reporter" access item for across all identities.
|
|
value:
|
|
name: Reporting Access Review
|
|
description: A review of everyone's access to the reporting system.
|
|
deadlineDuration: P2W
|
|
campaign:
|
|
name: Search Review
|
|
description: Review everyone's access to the reporting system.
|
|
type: SEARCH
|
|
filter:
|
|
type: CAMPAIGN_FILTER
|
|
id: e0adaae69852e8fe8b8a3d48e5ce757c
|
|
searchCampaignInfo:
|
|
type: ACCESS
|
|
query: '@access(name: ("reporter"))'
|
|
description: Identities with reporting abilities
|
|
emailNotificationEnabled: true
|
|
autoRevokeAllowed: false
|
|
recommendationsEnabled: false
|
|
mandatoryCommentRequirement: NO_DECISIONS
|
|
Source Owner:
|
|
description: This creates a template that can be used to generate source owner campaigns. The campaigns will have a due date that is one month after their creation date, and will review one source.
|
|
value:
|
|
name: AD Source Review
|
|
description: A review of our AD source.
|
|
deadlineDuration: P1M
|
|
campaign:
|
|
name: Source Review
|
|
description: Review everyone's access.
|
|
type: SOURCE_OWNER
|
|
filter:
|
|
type: CAMPAIGN_FILTER
|
|
id: e0adaae69852e8fe8b8a3d48e5ce757c
|
|
sourceOwnerCampaignInfo:
|
|
sourceIds:
|
|
- 2c918084707deba501709d45ce4e5569
|
|
emailNotificationEnabled: true
|
|
autoRevokeAllowed: false
|
|
recommendationsEnabled: false
|
|
correlatedStatus: CORRELATED
|
|
mandatoryCommentRequirement: NO_DECISIONS
|
|
RoleComposition:
|
|
description: This creates a template that can be used to generate role composition campaigns. The campaigns will have a due date that is two weeks after their creation date, and will be named "{current date} Role Composition Review" (e.g. "2020-03-16 Role Composition Review").
|
|
value:
|
|
name: Role Composition Review
|
|
description: A review of every role's access items, by the specified reviewer.
|
|
deadlineDuration: P2W
|
|
campaign:
|
|
name: Role Composition Review
|
|
description: Review all our roles.
|
|
type: ROLE_COMPOSITION
|
|
roleCompositionCampaignInfo:
|
|
remediatorRef:
|
|
type: IDENTITY
|
|
id: 2c9180876ab2c053016ab6f65dfd5aaa
|
|
emailNotificationEnabled: true
|
|
autoRevokeAllowed: false
|
|
recommendationsEnabled: false
|
|
mandatoryCommentRequirement: NO_DECISIONS
|
|
responses:
|
|
'200':
|
|
description: Created successfully.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1campaign-templates/post/requestBody/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/CampaignTemplate.yaml
|
|
examples:
|
|
Manager:
|
|
value:
|
|
id: e7dbec99d49349c8951bd84f58a05120
|
|
name: Manager Review
|
|
created: '2022-08-02T19:16:42.632Z'
|
|
modified: null
|
|
description: A review of everyone's access by their manager.
|
|
deadlineDuration: P14D
|
|
ownerRef:
|
|
email: support@testmail.identitysoon.com
|
|
type: IDENTITY
|
|
id: 7ec252acbd4245548bc25df22348cb75
|
|
name: SailPoint Support
|
|
scheduled: false
|
|
campaign:
|
|
created: null
|
|
modified: null
|
|
filter:
|
|
type: CAMPAIGN_FILTER
|
|
id: e0adaae69852e8fe8b8a3d48e5ce757c
|
|
name: Test Manager Filter
|
|
sunsetCommentsRequired: true
|
|
sourceOwnerCampaignInfo: null
|
|
searchCampaignInfo: null
|
|
roleCompositionCampaignInfo: null
|
|
alerts: null
|
|
totalCertifications: null
|
|
completedCertifications: null
|
|
sourcesWithOrphanEntitlements: null
|
|
id: null
|
|
name: Manager Review
|
|
description: Review everyone's access.
|
|
deadline: null
|
|
type: MANAGER
|
|
status: null
|
|
emailNotificationEnabled: true
|
|
autoRevokeAllowed: false
|
|
recommendationsEnabled: false
|
|
correlatedStatus: CORRELATED
|
|
mandatoryCommentRequirement: NO_DECISIONS
|
|
Search:
|
|
value:
|
|
id: b7e6459eed5247ac8b98a5fed81fe27f
|
|
name: Reporting Access Review
|
|
created: '2022-07-28T19:19:40.035Z'
|
|
modified: null
|
|
description: A review of everyone's access to the reporting system.
|
|
deadlineDuration: P14D
|
|
ownerRef:
|
|
email: support@testmail.identitysoon.com
|
|
type: IDENTITY
|
|
id: 7ec252acbd4245548bc25df22348cb75
|
|
name: SailPoint Support
|
|
scheduled: false
|
|
campaign:
|
|
created: null
|
|
modified: null
|
|
filter:
|
|
type: CAMPAIGN_FILTER
|
|
id: e0adaae69852e8fe8b8a3d48e5ce757c
|
|
name: Test Search Filter
|
|
sunsetCommentsRequired: true
|
|
sourceOwnerCampaignInfo: null
|
|
searchCampaignInfo:
|
|
type: ACCESS
|
|
description: Identities with reporting abilities
|
|
reviewerId: null
|
|
reviewer: null
|
|
query: '@access(name: ("reporter"))'
|
|
identityIds: null
|
|
accessConstraints: []
|
|
roleCompositionCampaignInfo: null
|
|
alerts: null
|
|
totalCertifications: null
|
|
completedCertifications: null
|
|
sourcesWithOrphanEntitlements: null
|
|
id: null
|
|
name: Search Campaign Review
|
|
description: Review everyone's access to the reporting system.
|
|
deadline: null
|
|
type: SEARCH
|
|
status: null
|
|
emailNotificationEnabled: true
|
|
autoRevokeAllowed: false
|
|
recommendationsEnabled: false
|
|
correlatedStatus: CORRELATED
|
|
mandatoryCommentRequirement: NO_DECISIONS
|
|
Source Owner:
|
|
value:
|
|
id: b9f41bc69e7a4291b9de0630396d030d
|
|
name: AD Source Review
|
|
created: '2022-08-02T13:40:36.857Z'
|
|
modified: null
|
|
description: A review of our AD source.
|
|
deadlineDuration: P1M
|
|
ownerRef:
|
|
email: support@testmail.identitysoon.com
|
|
type: IDENTITY
|
|
id: 7ec252acbd4245548bc25df22348cb75
|
|
name: SailPoint Support
|
|
scheduled: false
|
|
campaign:
|
|
created: null
|
|
modified: null
|
|
filter:
|
|
type: CAMPAIGN_FILTER
|
|
id: e0adaae69852e8fe8b8a3d48e5ce757c
|
|
name: Test Source Owner Filter
|
|
sunsetCommentsRequired: true
|
|
sourceOwnerCampaignInfo:
|
|
sourceIds:
|
|
- 2c918084707deba501709d45ce4e5569
|
|
searchCampaignInfo: null
|
|
roleCompositionCampaignInfo: null
|
|
alerts: null
|
|
totalCertifications: null
|
|
completedCertifications: null
|
|
sourcesWithOrphanEntitlements: null
|
|
id: null
|
|
name: AD Source Review
|
|
description: Review everyone's access.
|
|
deadline: null
|
|
type: SOURCE_OWNER
|
|
status: null
|
|
emailNotificationEnabled: true
|
|
autoRevokeAllowed: false
|
|
recommendationsEnabled: false
|
|
correlatedStatus: CORRELATED
|
|
mandatoryCommentRequirement: NO_DECISIONS
|
|
RoleComposition:
|
|
value:
|
|
id: b9f41bc69e7a4291b9de0630396d030d
|
|
name: Campaign With Admin Role
|
|
created: '2022-08-02T13:40:36.857Z'
|
|
modified: null
|
|
description: Campaign With Admin Role
|
|
deadlineDuration: null
|
|
ownerRef:
|
|
email: support@testmail.identitysoon.com
|
|
type: IDENTITY
|
|
id: 7ec252acbd4245548bc25df22348cb75
|
|
name: SailPoint Support
|
|
scheduled: false
|
|
campaign:
|
|
created: null
|
|
modified: null
|
|
filter: null
|
|
sunsetCommentsRequired: true
|
|
sourceOwnerCampaignInfo: null
|
|
searchCampaignInfo: null
|
|
roleCompositionCampaignInfo:
|
|
remediatorRef:
|
|
type: IDENTITY
|
|
id: 7ec252acbd4245548bc25df22348cb75
|
|
name: SailPoint Support
|
|
reviewerId: null
|
|
reviewer: null
|
|
roleIds:
|
|
- b15d609fc5c8434b865fe552315fda8f
|
|
query: null
|
|
description: null
|
|
alerts: null
|
|
totalCertifications: null
|
|
completedCertifications: null
|
|
sourcesWithOrphanEntitlements: null
|
|
id: null
|
|
name: Campaign With Admin Role
|
|
description: Campaign With Admin Role
|
|
deadline: null
|
|
type: ROLE_COMPOSITION
|
|
status: null
|
|
emailNotificationEnabled: false
|
|
autoRevokeAllowed: false
|
|
recommendationsEnabled: false
|
|
correlatedStatus: CORRELATED
|
|
mandatoryCommentRequirement: NO_DECISIONS
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$CampaignTemplate = @"
|
|
{
|
|
"ownerRef" : {
|
|
"name" : "Mister Manager",
|
|
"id" : "2c918086676d3e0601677611dbde220f",
|
|
"type" : "IDENTITY",
|
|
"email" : "mr.manager@example.com"
|
|
},
|
|
"deadlineDuration" : "P2W",
|
|
"created" : "2020-03-05T22:44:00.364Z",
|
|
"scheduled" : false,
|
|
"name" : "Manager Campaign Template",
|
|
"description" : "Template for the annual manager campaign.",
|
|
"modified" : "2020-03-05T22:52:09.969Z",
|
|
"campaign" : {
|
|
"totalCertifications" : 100,
|
|
"sourcesWithOrphanEntitlements" : [ {
|
|
"name" : "Source with orphan entitlements",
|
|
"id" : "2c90ad2a70ace7d50170acf22ca90010",
|
|
"type" : "SOURCE"
|
|
}, {
|
|
"name" : "Source with orphan entitlements",
|
|
"id" : "2c90ad2a70ace7d50170acf22ca90010",
|
|
"type" : "SOURCE"
|
|
} ],
|
|
"recommendationsEnabled" : true,
|
|
"sunsetCommentsRequired" : true,
|
|
"created" : "2020-03-03T22:15:13.611Z",
|
|
"machineAccountCampaignInfo" : {
|
|
"reviewerType" : "ACCOUNT_OWNER",
|
|
"sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ]
|
|
},
|
|
"description" : "Everyone needs to be reviewed by their manager",
|
|
"type" : "MANAGER",
|
|
"sourceOwnerCampaignInfo" : {
|
|
"sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ]
|
|
},
|
|
"emailNotificationEnabled" : false,
|
|
"alerts" : [ {
|
|
"level" : "ERROR",
|
|
"localizations" : [ {
|
|
"localeOrigin" : "DEFAULT",
|
|
"text" : "The request was syntactically correct but its content is semantically invalid.",
|
|
"locale" : "en-US"
|
|
}, {
|
|
"localeOrigin" : "DEFAULT",
|
|
"text" : "The request was syntactically correct but its content is semantically invalid.",
|
|
"locale" : "en-US"
|
|
} ]
|
|
}, {
|
|
"level" : "ERROR",
|
|
"localizations" : [ {
|
|
"localeOrigin" : "DEFAULT",
|
|
"text" : "The request was syntactically correct but its content is semantically invalid.",
|
|
"locale" : "en-US"
|
|
}, {
|
|
"localeOrigin" : "DEFAULT",
|
|
"text" : "The request was syntactically correct but its content is semantically invalid.",
|
|
"locale" : "en-US"
|
|
} ]
|
|
} ],
|
|
"filter" : {
|
|
"name" : "Test Filter",
|
|
"id" : "0fbe863c063c4c88a35fd7f17e8a3df5",
|
|
"type" : "CAMPAIGN_FILTER"
|
|
},
|
|
"searchCampaignInfo" : {
|
|
"identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ],
|
|
"query" : "Search Campaign query description",
|
|
"description" : "Search Campaign description",
|
|
"reviewer" : {
|
|
"name" : "William Wilson",
|
|
"id" : "2c91808568c529c60168cca6f90c1313",
|
|
"type" : "IDENTITY"
|
|
},
|
|
"type" : "ACCESS",
|
|
"accessConstraints" : [ {
|
|
"ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ],
|
|
"type" : "ENTITLEMENT",
|
|
"operator" : "SELECTED"
|
|
}, {
|
|
"ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ],
|
|
"type" : "ENTITLEMENT",
|
|
"operator" : "SELECTED"
|
|
}, {
|
|
"ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ],
|
|
"type" : "ENTITLEMENT",
|
|
"operator" : "SELECTED"
|
|
}, {
|
|
"ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ],
|
|
"type" : "ENTITLEMENT",
|
|
"operator" : "SELECTED"
|
|
}, {
|
|
"ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ],
|
|
"type" : "ENTITLEMENT",
|
|
"operator" : "SELECTED"
|
|
} ]
|
|
},
|
|
"autoRevokeAllowed" : false,
|
|
"name" : "Manager Campaign",
|
|
"mandatoryCommentRequirement" : "NO_DECISIONS",
|
|
"modified" : "2020-03-03T22:20:12.674Z",
|
|
"roleCompositionCampaignInfo" : {
|
|
"remediatorRef" : {
|
|
"name" : "Role Admin",
|
|
"id" : "2c90ad2a70ace7d50170acf22ca90010",
|
|
"type" : "IDENTITY"
|
|
},
|
|
"roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ],
|
|
"query" : "Search Query",
|
|
"description" : "Role Composition Description",
|
|
"reviewer" : {
|
|
"name" : "William Wilson",
|
|
"id" : "2c91808568c529c60168cca6f90c1313",
|
|
"type" : "IDENTITY"
|
|
}
|
|
},
|
|
"completedCertifications" : 10,
|
|
"id" : "2c9079b270a266a60170a2779fcb0007",
|
|
"deadline" : "2020-03-15T10:00:01.456Z",
|
|
"status" : "ACTIVE",
|
|
"correlatedStatus" : "CORRELATED"
|
|
},
|
|
"id" : "2c9079b270a266a60170a277bb960008"
|
|
}
|
|
"@
|
|
|
|
# Create a Campaign Template
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate
|
|
New-CampaignTemplate-CampaignTemplate $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# New-CampaignTemplate -CampaignTemplate $CampaignTemplate
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-CampaignTemplate"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
get:
|
|
operationId: getCampaignTemplates
|
|
tags:
|
|
- Certification Campaigns
|
|
summary: List Campaign Templates
|
|
description: |
|
|
Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params.
|
|
|
|
The API returns all campaign templates matching the query parameters.
|
|
security:
|
|
- userAuth:
|
|
- idn:campaign-template:read
|
|
- idn:campaign-template:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- CERT_ADMIN
|
|
parameters:
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
- in: query
|
|
name: sorters
|
|
schema:
|
|
type: string
|
|
format: comma-separated
|
|
description: |-
|
|
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
|
|
|
Sorting is supported for the following fields: **name, created, modified**
|
|
example: name
|
|
- in: query
|
|
name: filters
|
|
schema:
|
|
type: string
|
|
format: comma-separated
|
|
description: |-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
**name**: *eq, ge, gt, in, le, lt, ne, sw*
|
|
|
|
**id**: *eq, ge, gt, in, le, lt, ne, sw*
|
|
example: name eq "manager template"
|
|
responses:
|
|
'200':
|
|
description: List of campaign template objects.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1campaign-templates/post/requestBody/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/CampaignTemplate.yaml
|
|
example:
|
|
- id: e7dbec99d49349c8951bd84f58a05120
|
|
name: Manager Review
|
|
created: '2022-08-02T19:16:42.632Z'
|
|
modified: null
|
|
description: A review of everyone's access by their manager.
|
|
deadlineDuration: P14D
|
|
ownerRef:
|
|
email: support@testmail.identitysoon.com
|
|
type: IDENTITY
|
|
id: 7ec252acbd4245548bc25df22348cb75
|
|
name: SailPoint Support
|
|
scheduled: false
|
|
campaign:
|
|
created: null
|
|
modified: null
|
|
filter:
|
|
type: CAMPAIGN_FILTER
|
|
id: e0adaae69852e8fe8b8a3d48e5ce757c
|
|
name: Test Manager Filter
|
|
sunsetCommentsRequired: true
|
|
sourceOwnerCampaignInfo: null
|
|
searchCampaignInfo: null
|
|
roleCompositionCampaignInfo: null
|
|
alerts: null
|
|
totalCertifications: null
|
|
completedCertifications: null
|
|
sourcesWithOrphanEntitlements: null
|
|
id: null
|
|
name: Manager Review
|
|
description: Review everyone's access.
|
|
deadline: null
|
|
type: MANAGER
|
|
status: null
|
|
emailNotificationEnabled: true
|
|
autoRevokeAllowed: false
|
|
recommendationsEnabled: false
|
|
mandatoryCommentRequirement: NO_DECISIONS
|
|
- id: b7e6459eed5247ac8b98a5fed81fe27f
|
|
name: Reporting Access Review
|
|
created: '2022-07-28T19:19:40.035Z'
|
|
modified: null
|
|
description: A review of everyone's access to the reporting system.
|
|
deadlineDuration: P14D
|
|
ownerRef:
|
|
email: support@testmail.identitysoon.com
|
|
type: IDENTITY
|
|
id: 7ec252acbd4245548bc25df22348cb75
|
|
name: SailPoint Support
|
|
scheduled: false
|
|
campaign:
|
|
created: null
|
|
modified: null
|
|
filter:
|
|
type: CAMPAIGN_FILTER
|
|
id: e0adaae69852e8fe8b8a3d48e5ce757c
|
|
name: Test Search Filter
|
|
sunsetCommentsRequired: true
|
|
sourceOwnerCampaignInfo: null
|
|
searchCampaignInfo:
|
|
type: ACCESS
|
|
description: Identities with reporting abilities
|
|
reviewerId: null
|
|
reviewer: null
|
|
query: '@access(name: ("reporter"))'
|
|
identityIds: null
|
|
accessConstraints: []
|
|
roleCompositionCampaignInfo: null
|
|
alerts: null
|
|
totalCertifications: null
|
|
completedCertifications: null
|
|
sourcesWithOrphanEntitlements: null
|
|
id: null
|
|
name: Search Campaign
|
|
description: Review everyone's access to the reporting system.
|
|
deadline: null
|
|
type: SEARCH
|
|
status: null
|
|
emailNotificationEnabled: true
|
|
autoRevokeAllowed: false
|
|
recommendationsEnabled: false
|
|
mandatoryCommentRequirement: NO_DECISIONS
|
|
- id: b9f41bc69e7a4291b9de0630396d030d
|
|
name: Campaign With Admin Role
|
|
created: '2022-08-02T13:40:36.857Z'
|
|
modified: null
|
|
description: Campaign With Admin Role
|
|
deadlineDuration: null
|
|
ownerRef:
|
|
email: support@testmail.identitysoon.com
|
|
type: IDENTITY
|
|
id: 7ec252acbd4245548bc25df22348cb75
|
|
name: SailPoint Support
|
|
scheduled: false
|
|
campaign:
|
|
created: null
|
|
modified: null
|
|
filter: null
|
|
sunsetCommentsRequired: true
|
|
sourceOwnerCampaignInfo: null
|
|
searchCampaignInfo: null
|
|
roleCompositionCampaignInfo:
|
|
remediatorRef:
|
|
type: IDENTITY
|
|
id: 7ec252acbd4245548bc25df22348cb75
|
|
name: SailPoint Support
|
|
reviewerId: null
|
|
reviewer: null
|
|
roleIds:
|
|
- b15d609fc5c8434b865fe552315fda8f
|
|
query: null
|
|
description: null
|
|
alerts: null
|
|
totalCertifications: null
|
|
completedCertifications: null
|
|
sourcesWithOrphanEntitlements: null
|
|
id: null
|
|
name: Campaign With Admin Role
|
|
description: Campaign With Admin Role
|
|
deadline: null
|
|
type: ROLE_COMPOSITION
|
|
status: null
|
|
emailNotificationEnabled: false
|
|
autoRevokeAllowed: false
|
|
recommendationsEnabled: false
|
|
mandatoryCommentRequirement: NO_DECISIONS
|
|
- id: b9f41bc69e7a4291b9de0630396d030d
|
|
name: AD Source Review
|
|
created: '2022-08-02T13:40:36.857Z'
|
|
modified: null
|
|
description: A review of our AD source.
|
|
deadlineDuration: P1M
|
|
ownerRef:
|
|
email: support@testmail.identitysoon.com
|
|
type: IDENTITY
|
|
id: 7ec252acbd4245548bc25df22348cb75
|
|
name: SailPoint Support
|
|
scheduled: false
|
|
campaign:
|
|
created: null
|
|
modified: null
|
|
filter:
|
|
type: CAMPAIGN_FILTER
|
|
id: e0adaae69852e8fe8b8a3d48e5ce757c
|
|
name: Test Source Owner Filter
|
|
sunsetCommentsRequired: true
|
|
sourceOwnerCampaignInfo:
|
|
sourceIds:
|
|
- 2c918084707deba501709d45ce4e5569
|
|
searchCampaignInfo: null
|
|
roleCompositionCampaignInfo: null
|
|
alerts: null
|
|
totalCertifications: null
|
|
completedCertifications: null
|
|
sourcesWithOrphanEntitlements: null
|
|
id: null
|
|
name: AD Source Review
|
|
description: Review everyone's access.
|
|
deadline: null
|
|
type: SOURCE_OWNER
|
|
status: null
|
|
emailNotificationEnabled: true
|
|
autoRevokeAllowed: false
|
|
recommendationsEnabled: false
|
|
correlatedStatus: CORRELATED
|
|
mandatoryCommentRequirement: NO_DECISIONS
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional)
|
|
$Filters = "name eq "manager template"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional)
|
|
|
|
# List Campaign Templates
|
|
|
|
try {
|
|
Get-CampaignTemplates
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-CampaignTemplates -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignTemplates"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/campaign-templates/{id}:
|
|
patch:
|
|
operationId: patchCampaignTemplate
|
|
tags:
|
|
- Certification Campaigns
|
|
summary: Update a Campaign Template
|
|
description: |
|
|
Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
security:
|
|
- userAuth:
|
|
- idn:campaign-template:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- CERT_ADMIN
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getCampaignTemplates
|
|
description: ID of the campaign template being modified.
|
|
example: 2c9180835d191a86015d28455b4a2329
|
|
requestBody:
|
|
required: true
|
|
description: |
|
|
A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
|
|
The following fields are patchable:
|
|
* name
|
|
* description
|
|
* deadlineDuration
|
|
* campaign (all fields that are allowed during create)
|
|
content:
|
|
application/json-patch+json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/JsonPatchOperation.yaml
|
|
example:
|
|
- op: replace
|
|
path: /description
|
|
value: Updated description!
|
|
- op: replace
|
|
path: /campaign/filter/id
|
|
value: ff80818155fe8c080155fe8d925b0316
|
|
responses:
|
|
'200':
|
|
description: This response indicates that the PATCH operation succeeded, and the API returns the template's new representation.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1campaign-templates/post/requestBody/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/CampaignTemplate.yaml
|
|
examples:
|
|
Manager:
|
|
$ref: '#/paths/~1campaign-templates/post/responses/200/content/application~1json/examples/Manager'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/campaign/examples/CampaignTemplateManager.yaml
|
|
Search:
|
|
$ref: '#/paths/~1campaign-templates/post/responses/200/content/application~1json/examples/Search'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/campaign/examples/CampaignTemplateSearch.yaml
|
|
Source Owner:
|
|
$ref: '#/paths/~1campaign-templates/post/responses/200/content/application~1json/examples/Source%20Owner'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/campaign/examples/CampaignTemplateSourceOwner.yaml
|
|
RoleComposition:
|
|
$ref: '#/paths/~1campaign-templates/post/responses/200/content/application~1json/examples/RoleComposition'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/campaign/examples/CampaignTemplateRoleComposition.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being modified.
|
|
# JsonPatchOperation[] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create)
|
|
$JsonPatchOperation = @"{
|
|
"op" : "replace",
|
|
"path" : "/description",
|
|
"value" : "New description"
|
|
}"@
|
|
|
|
|
|
# Update a Campaign Template
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
|
|
Update-CampaignTemplate-Id $Id -JsonPatchOperation $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Update-CampaignTemplate -Id $Id -JsonPatchOperation $JsonPatchOperation
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-CampaignTemplate"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
get:
|
|
operationId: getCampaignTemplate
|
|
tags:
|
|
- Certification Campaigns
|
|
summary: Get a Campaign Template
|
|
description: |
|
|
Use this API to fetch a certification campaign template by ID.
|
|
security:
|
|
- userAuth:
|
|
- idn:campaign-template:read
|
|
- idn:campaign-template:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- CERT_ADMIN
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getCampaignTemplates
|
|
description: Requested campaign template's ID.
|
|
example: 2c9180835d191a86015d28455b4a2329
|
|
responses:
|
|
'200':
|
|
description: Data for the campaign matching the given ID.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1campaign-templates/post/requestBody/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/CampaignTemplate.yaml
|
|
examples:
|
|
Manager:
|
|
$ref: '#/paths/~1campaign-templates/post/responses/200/content/application~1json/examples/Manager'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/campaign/examples/CampaignTemplateManager.yaml
|
|
Search:
|
|
$ref: '#/paths/~1campaign-templates/post/responses/200/content/application~1json/examples/Search'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/campaign/examples/CampaignTemplateSearch.yaml
|
|
Source Owner:
|
|
$ref: '#/paths/~1campaign-templates/post/responses/200/content/application~1json/examples/Source%20Owner'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/campaign/examples/CampaignTemplateSourceOwner.yaml
|
|
RoleComposition:
|
|
$ref: '#/paths/~1campaign-templates/post/responses/200/content/application~1json/examples/RoleComposition'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/campaign/examples/CampaignTemplateRoleComposition.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "2c9180835d191a86015d28455b4a2329" # String | Requested campaign template's ID.
|
|
|
|
# Get a Campaign Template
|
|
|
|
try {
|
|
Get-CampaignTemplate-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-CampaignTemplate -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignTemplate"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
delete:
|
|
operationId: deleteCampaignTemplate
|
|
tags:
|
|
- Certification Campaigns
|
|
summary: Delete a Campaign Template
|
|
description: |
|
|
Use this API to delete a certification campaign template by ID.
|
|
security:
|
|
- userAuth:
|
|
- idn:campaign-template:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- CERT_ADMIN
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getCampaignTemplates
|
|
description: ID of the campaign template being deleted.
|
|
example: 2c9180835d191a86015d28455b4a2329
|
|
responses:
|
|
'204':
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/204.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being deleted.
|
|
|
|
# Delete a Campaign Template
|
|
|
|
try {
|
|
Remove-CampaignTemplate-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Remove-CampaignTemplate -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-CampaignTemplate"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/campaign-templates/{id}/schedule:
|
|
get:
|
|
operationId: getCampaignTemplateSchedule
|
|
tags:
|
|
- Certification Campaigns
|
|
summary: Get Campaign Template Schedule
|
|
description: |
|
|
Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set.
|
|
security:
|
|
- userAuth: []
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- CERT_ADMIN
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getCampaignTemplates
|
|
description: ID of the campaign template whose schedule is being fetched.
|
|
example: 04bedce387bd47b2ae1f86eb0bb36dee
|
|
responses:
|
|
'200':
|
|
description: Current schedule for the campaign template. See the [Set Campaign Template Schedule endpoint documentation](https://developer.sailpoint.com/docs/api/v3/set-campaign-template-schedule) for more examples.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: Determines the overall schedule cadence. In general, all time period fields smaller than the chosen type can be configured. For example, a DAILY schedule can have 'hours' set, but not 'days'; a WEEKLY schedule can have both 'hours' and 'days' set.
|
|
enum:
|
|
- WEEKLY
|
|
- MONTHLY
|
|
- ANNUALLY
|
|
- CALENDAR
|
|
example: WEEKLY
|
|
months:
|
|
type: object
|
|
description: |
|
|
Specifies which months of a schedule are active. Only valid for ANNUALLY schedule types. Examples:
|
|
|
|
On February and March:
|
|
* type LIST
|
|
* values "2", "3"
|
|
|
|
Every 3 months, starting in January (quarterly):
|
|
* type LIST
|
|
* values "1"
|
|
* interval 3
|
|
|
|
Every two months between July and December:
|
|
* type RANGE
|
|
* values "7", "12"
|
|
* interval 2
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: Enum type to specify months value
|
|
enum:
|
|
- LIST
|
|
- RANGE
|
|
example: LIST
|
|
values:
|
|
type: array
|
|
description: Values of the months based on the enum type mentioned above
|
|
items:
|
|
type: string
|
|
example:
|
|
- '1'
|
|
interval:
|
|
type: integer
|
|
example: 2
|
|
format: int64
|
|
description: Interval between the cert generations
|
|
required:
|
|
- type
|
|
- values
|
|
days:
|
|
type: object
|
|
description: |
|
|
Specifies which day(s) a schedule is active for. This is required for all schedule types.
|
|
The "values" field holds different data depending on the type of schedule:
|
|
* WEEKLY: days of the week (1-7)
|
|
* MONTHLY: days of the month (1-31, L, L-1...)
|
|
* ANNUALLY: if the "months" field is also set: days of the month (1-31, L, L-1...); otherwise: ISO-8601 dates without year ("--12-31")
|
|
* CALENDAR: ISO-8601 dates ("2020-12-31")
|
|
|
|
Note that CALENDAR only supports the LIST type, and ANNUALLY does not support the RANGE type when provided
|
|
with ISO-8601 dates without year.
|
|
|
|
Examples:
|
|
|
|
On Sundays:
|
|
* type LIST
|
|
* values "1"
|
|
|
|
The second to last day of the month:
|
|
* type LIST
|
|
* values "L-1"
|
|
|
|
From the 20th to the last day of the month:
|
|
* type RANGE
|
|
* values "20", "L"
|
|
|
|
Every March 2nd:
|
|
* type LIST
|
|
* values "--03-02"
|
|
|
|
On March 2nd, 2021:
|
|
* type: LIST
|
|
* values "2021-03-02"
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: Enum type to specify days value
|
|
enum:
|
|
- LIST
|
|
- RANGE
|
|
example: LIST
|
|
values:
|
|
type: array
|
|
description: Values of the days based on the enum type mentioned above
|
|
items:
|
|
type: string
|
|
example:
|
|
- '1'
|
|
interval:
|
|
type: integer
|
|
example: 2
|
|
format: int64
|
|
description: Interval between the cert generations
|
|
required:
|
|
- type
|
|
- values
|
|
hours:
|
|
type: object
|
|
description: |
|
|
Specifies which hour(s) a schedule is active for. Examples:
|
|
|
|
Every three hours starting from 8AM, inclusive:
|
|
* type LIST
|
|
* values "8"
|
|
* interval 3
|
|
|
|
During business hours:
|
|
* type RANGE
|
|
* values "9", "5"
|
|
|
|
At 5AM, noon, and 5PM:
|
|
* type LIST
|
|
* values "5", "12", "17"
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: Enum type to specify hours value
|
|
enum:
|
|
- LIST
|
|
- RANGE
|
|
example: LIST
|
|
values:
|
|
type: array
|
|
description: Values of the days based on the enum type mentioned above
|
|
items:
|
|
type: string
|
|
example:
|
|
- '1'
|
|
interval:
|
|
type: integer
|
|
format: int64
|
|
example: 2
|
|
description: Interval between the cert generations
|
|
required:
|
|
- type
|
|
- values
|
|
expiration:
|
|
type: string
|
|
format: date-time
|
|
description: Specifies the time after which this schedule will no longer occur.
|
|
example: '2022-09-19 13:55:26'
|
|
timeZoneId:
|
|
type: string
|
|
description: The time zone to use when running the schedule. For instance, if the schedule is scheduled to run at 1AM, and this field is set to "CST", the schedule will run at 1AM CST.
|
|
example: CST
|
|
required:
|
|
- type
|
|
- hours
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being fetched.
|
|
|
|
# Get Campaign Template Schedule
|
|
|
|
try {
|
|
Get-CampaignTemplateSchedule-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-CampaignTemplateSchedule -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignTemplateSchedule"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
put:
|
|
operationId: setCampaignTemplateSchedule
|
|
tags:
|
|
- Certification Campaigns
|
|
summary: Set Campaign Template Schedule
|
|
description: |
|
|
Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one.
|
|
security:
|
|
- userAuth: []
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- CERT_ADMIN
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getCampaignTemplates
|
|
description: ID of the campaign template being scheduled.
|
|
example: 04bedce387bd47b2ae1f86eb0bb36dee
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1campaign-templates~1%7Bid%7D~1schedule/get/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/Schedule.yaml
|
|
examples:
|
|
Monthly:
|
|
description: Runs on the 15th and last day of the month, at 5PM.
|
|
value:
|
|
type: MONTHLY
|
|
hours:
|
|
type: LIST
|
|
values:
|
|
- '17'
|
|
days:
|
|
type: LIST
|
|
values:
|
|
- '15'
|
|
Once a year:
|
|
description: Runs every January 1st at midnight.
|
|
value:
|
|
type: ANNUALLY
|
|
hours:
|
|
type: LIST
|
|
values:
|
|
- '0'
|
|
days:
|
|
type: LIST
|
|
values:
|
|
- '--01-01'
|
|
Quarterly:
|
|
description: Runs once a quarter (every 3 months) on the first of the month at 1AM.
|
|
value:
|
|
type: ANNUALLY
|
|
hours:
|
|
type: LIST
|
|
values:
|
|
- '1'
|
|
days:
|
|
type: LIST
|
|
values:
|
|
- '1'
|
|
months:
|
|
type: LIST
|
|
values:
|
|
- '1'
|
|
interval: 3
|
|
Yearly on Specific Days:
|
|
description: Runs on March 12 and December 5 at 1AM, every year.
|
|
value:
|
|
type: ANNUALLY
|
|
hours:
|
|
type: LIST
|
|
values:
|
|
- '1'
|
|
days:
|
|
type: LIST
|
|
values:
|
|
- '--03-12'
|
|
- '--12-05'
|
|
On a Specific Date:
|
|
description: Runs at 1AM on February 18th, 2020
|
|
value:
|
|
type: CALENDAR
|
|
hours:
|
|
type: LIST
|
|
values:
|
|
- '1'
|
|
days:
|
|
type: LIST
|
|
values:
|
|
- '2020-02-18'
|
|
responses:
|
|
'204':
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/204.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template being scheduled.
|
|
$Schedule = @"
|
|
{
|
|
"hours" : {
|
|
"values" : [ "1" ],
|
|
"interval" : 2,
|
|
"type" : "LIST"
|
|
},
|
|
"months" : {
|
|
"values" : [ "1" ],
|
|
"interval" : 2,
|
|
"type" : "LIST"
|
|
},
|
|
"timeZoneId" : "CST",
|
|
"days" : {
|
|
"values" : [ "1" ],
|
|
"interval" : 2,
|
|
"type" : "LIST"
|
|
},
|
|
"expiration" : "2000-01-23T04:56:07.000+00:00",
|
|
"type" : "WEEKLY"
|
|
}
|
|
"@
|
|
|
|
# Set Campaign Template Schedule
|
|
|
|
try {
|
|
Set-CampaignTemplateSchedule-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Set-CampaignTemplateSchedule -Id $Id -Schedule $Schedule
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-CampaignTemplateSchedule"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
delete:
|
|
operationId: deleteCampaignTemplateSchedule
|
|
tags:
|
|
- Certification Campaigns
|
|
summary: Delete Campaign Template Schedule
|
|
description: |
|
|
Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set.
|
|
security:
|
|
- userAuth: []
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- CERT_ADMIN
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getCampaignTemplates
|
|
description: ID of the campaign template whose schedule is being deleted.
|
|
example: 04bedce387bd47b2ae1f86eb0bb36dee
|
|
responses:
|
|
'204':
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/204.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being deleted.
|
|
|
|
# Delete Campaign Template Schedule
|
|
|
|
try {
|
|
Remove-CampaignTemplateSchedule-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Remove-CampaignTemplateSchedule -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-CampaignTemplateSchedule"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/campaign-templates/{id}/generate:
|
|
post:
|
|
operationId: startGenerateCampaignTemplate
|
|
tags:
|
|
- Certification Campaigns
|
|
summary: Generate a Campaign from Template
|
|
security:
|
|
- userAuth:
|
|
- idn:campaign-template:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- CERT_ADMIN
|
|
description: |
|
|
Use this API to generate a new certification campaign from a campaign template.
|
|
|
|
The campaign object contained in the template has special formatting applied to its name and description
|
|
fields that determine the generated campaign's name/description. Placeholders in those fields are
|
|
formatted with the current date and time upon generation.
|
|
|
|
Placeholders consist of a percent sign followed by a letter indicating what should be inserted. For
|
|
example, "%Y" inserts the current year, and a campaign template named "Campaign for %y" generates a
|
|
campaign called "Campaign for 2020" (assuming the year at generation time is 2020).
|
|
|
|
Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html).
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getCampaignTemplates
|
|
description: ID of the campaign template to use for generation.
|
|
example: 2c9180835d191a86015d28455b4a2329
|
|
responses:
|
|
'200':
|
|
description: This response indicates that a campaign was successfully generated from this template, and the API returns a reference to the new campaign.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Certification/properties/campaign'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/CampaignReference.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template to use for generation.
|
|
|
|
# Generate a Campaign from Template
|
|
|
|
try {
|
|
Start-GenerateCampaignTemplate-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Start-GenerateCampaignTemplate -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-GenerateCampaignTemplate"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/certifications:
|
|
get:
|
|
operationId: listIdentityCertifications
|
|
tags:
|
|
- Certifications
|
|
summary: List Identity Campaign Certifications
|
|
description: Use this API to get a list of identity campaign certifications for the specified query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to governance groups.
|
|
parameters:
|
|
- in: query
|
|
name: reviewer-identity
|
|
schema:
|
|
type: string
|
|
example: me
|
|
description: Reviewer's identity. *me* indicates the current user.
|
|
required: false
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
- in: query
|
|
name: filters
|
|
required: false
|
|
schema:
|
|
type: string
|
|
example: id eq "ef38f94347e94562b5bb8424a56397d8"
|
|
description: |-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
**id**: *eq, in*
|
|
|
|
**campaign.id**: *eq, in*
|
|
|
|
**phase**: *eq*
|
|
|
|
**completed**: *eq*
|
|
- in: query
|
|
name: sorters
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: comma-separated
|
|
example: name,due
|
|
description: |-
|
|
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
|
|
|
Sorting is supported for the following fields: **name, due, signed**
|
|
responses:
|
|
'200':
|
|
description: List of identity campaign certifications.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
example: 2c9180835d2e5168015d32f890ca1581
|
|
type: string
|
|
description: id of the certification
|
|
name:
|
|
example: Source Owner Access Review for Employees [source]
|
|
type: string
|
|
description: name of the certification
|
|
campaign:
|
|
$ref: '#/components/schemas/Certification/properties/campaign'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/CampaignReference.yaml
|
|
completed:
|
|
type: boolean
|
|
description: Have all decisions been made?
|
|
example: true
|
|
identitiesCompleted:
|
|
type: integer
|
|
description: The number of identities for whom all decisions have been made and are complete.
|
|
example: 5
|
|
format: int32
|
|
identitiesTotal:
|
|
type: integer
|
|
description: The total number of identities in the Certification, both complete and incomplete.
|
|
example: 10
|
|
format: int32
|
|
created:
|
|
example: '2018-06-25T20:22:28.104Z'
|
|
format: date-time
|
|
type: string
|
|
description: created date
|
|
modified:
|
|
example: '2018-06-25T20:22:28.104Z'
|
|
format: date-time
|
|
type: string
|
|
description: modified date
|
|
decisionsMade:
|
|
type: integer
|
|
description: The number of approve/revoke/acknowledge decisions that have been made.
|
|
example: 20
|
|
format: int32
|
|
decisionsTotal:
|
|
type: integer
|
|
description: The total number of approve/revoke/acknowledge decisions.
|
|
example: 40
|
|
format: int32
|
|
due:
|
|
type: string
|
|
format: date-time
|
|
description: The due date of the certification.
|
|
example: '2018-10-19T13:49:37.385Z'
|
|
signed:
|
|
type: string
|
|
format: date-time
|
|
nullable: true
|
|
description: The date the reviewer signed off on the Certification.
|
|
example: '2018-10-19T13:49:37.385Z'
|
|
reviewer:
|
|
$ref: '#/components/schemas/Certification/properties/reviewer'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/Reviewer.yaml
|
|
reassignment:
|
|
$ref: '#/components/schemas/Certification/properties/reassignment'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/Reassignment.yaml
|
|
hasErrors:
|
|
description: Identifies if the certification has an error
|
|
type: boolean
|
|
example: false
|
|
errorMessage:
|
|
description: Description of the certification error
|
|
nullable: true
|
|
type: string
|
|
example: The certification has an error
|
|
phase:
|
|
$ref: '#/components/schemas/Certification/properties/phase'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/CertificationPhase.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$ReviewerIdentity = "me" # String | Reviewer's identity. *me* indicates the current user. (optional)
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
$Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* (optional)
|
|
$Sorters = "name,due" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, due, signed** (optional)
|
|
|
|
# List Identity Campaign Certifications
|
|
|
|
try {
|
|
Get-IdentityCertifications
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-IdentityCertifications -ReviewerIdentity $ReviewerIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityCertifications"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/certifications/{id}:
|
|
get:
|
|
operationId: getIdentityCertification
|
|
tags:
|
|
- Certifications
|
|
summary: Identity Certification by ID
|
|
security:
|
|
- userAuth: []
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- CERT_ADMIN
|
|
description: This API returns a single identity campaign certification by its ID. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listIdentityCertifications
|
|
description: The certification id
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
responses:
|
|
'200':
|
|
description: An identity campaign certification object
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1certifications/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/IdentityCertificationDto.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification id
|
|
|
|
# Identity Certification by ID
|
|
|
|
try {
|
|
Get-IdentityCertification-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-IdentityCertification -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityCertification"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/certifications/{id}/access-review-items:
|
|
get:
|
|
operationId: listIdentityAccessReviewItems
|
|
tags:
|
|
- Certifications
|
|
summary: List of Access Review Items
|
|
security:
|
|
- userAuth: []
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- CERT_ADMIN
|
|
description: This API returns a list of access review items for an identity campaign certification. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listIdentityCertifications
|
|
description: The identity campaign certification ID
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
- in: query
|
|
required: false
|
|
name: filters
|
|
schema:
|
|
type: string
|
|
description: |-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
**id**: *eq, in*
|
|
|
|
**type**: *eq*
|
|
|
|
**access.type**: *eq*
|
|
|
|
**completed**: *eq, ne*
|
|
|
|
**identitySummary.id**: *eq, in*
|
|
|
|
**identitySummary.name**: *eq, sw*
|
|
|
|
**access.id**: *eq, in*
|
|
|
|
**access.name**: *eq, sw*
|
|
|
|
**entitlement.sourceName**: *eq, sw*
|
|
|
|
**accessProfile.sourceName**: *eq, sw*
|
|
example: id eq "ef38f94347e94562b5bb8424a56397d8"
|
|
- in: query
|
|
name: sorters
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: comma-separated
|
|
example: access.name,-accessProfile.sourceName
|
|
description: |-
|
|
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
|
|
|
Sorting is supported for the following fields: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName**
|
|
- in: query
|
|
name: entitlements
|
|
required: false
|
|
schema:
|
|
type: string
|
|
example: identityEntitlement
|
|
description: |-
|
|
Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs.
|
|
|
|
An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time.
|
|
- in: query
|
|
name: access-profiles
|
|
required: false
|
|
schema:
|
|
type: string
|
|
example: accessProfile1
|
|
description: |-
|
|
Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs.
|
|
|
|
An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time.
|
|
- in: query
|
|
name: roles
|
|
required: false
|
|
schema:
|
|
type: string
|
|
example: userRole
|
|
description: |-
|
|
Filter results to view access review items that pertain to any of the specified comma-separated role IDs.
|
|
|
|
An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time.
|
|
responses:
|
|
'200':
|
|
description: A list of access review items
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
accessSummary:
|
|
$ref: '#/paths/~1certifications~1%7Bid%7D~1access-summaries~1%7Btype%7D/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/AccessSummary.yaml
|
|
identitySummary:
|
|
$ref: '#/paths/~1certifications~1%7Bid%7D~1identity-summaries/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/CertificationIdentitySummary.yaml
|
|
id:
|
|
type: string
|
|
description: The review item's id
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
completed:
|
|
type: boolean
|
|
description: Whether the review item is complete
|
|
example: false
|
|
newAccess:
|
|
type: boolean
|
|
description: Indicates whether the review item is for new access to a source
|
|
example: false
|
|
decision:
|
|
type: string
|
|
description: The decision to approve or revoke the review item
|
|
enum:
|
|
- APPROVE
|
|
- REVOKE
|
|
example: APPROVE
|
|
comments:
|
|
nullable: true
|
|
type: string
|
|
description: Comments for this review item
|
|
example: This user still needs access to this source
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
$Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional)
|
|
$Sorters = "access.name,-accessProfile.sourceName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** (optional)
|
|
$Entitlements = "identityEntitlement" # String | Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. (optional)
|
|
$AccessProfiles = "accessProfile1" # String | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional)
|
|
$Roles = "userRole" # String | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional)
|
|
|
|
# List of Access Review Items
|
|
|
|
try {
|
|
Get-IdentityAccessReviewItems-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-IdentityAccessReviewItems -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -Entitlements $Entitlements -AccessProfiles $AccessProfiles -Roles $Roles
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityAccessReviewItems"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/certifications/{id}/decide:
|
|
post:
|
|
operationId: makeIdentityDecision
|
|
tags:
|
|
- Certifications
|
|
summary: Decide on a Certification Item
|
|
security:
|
|
- userAuth: []
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- CERT_ADMIN
|
|
description: The API makes a decision to approve or revoke one or more identity campaign certification items. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listIdentityCertifications
|
|
description: The ID of the identity campaign certification on which to make decisions
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
requestBody:
|
|
required: true
|
|
description: A non-empty array of decisions to be made.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The id of the review decision
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
decision:
|
|
$ref: '#/paths/~1certifications~1%7Bid%7D~1access-review-items/get/responses/200/content/application~1json/schema/items/properties/decision'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/CertificationDecision.yaml
|
|
proposedEndDate:
|
|
type: string
|
|
format: date-time
|
|
example: '2017-07-11T18:45:37.098Z'
|
|
description: The date at which a user's access should be taken away. Should only be set for `REVOKE` decisions.
|
|
bulk:
|
|
type: boolean
|
|
description: Indicates whether decision should be marked as part of a larger bulk decision
|
|
example: true
|
|
recommendation:
|
|
type: object
|
|
properties:
|
|
recommendation:
|
|
type: string
|
|
description: The recommendation from IAI at the time of the decision. This field will be null if no recommendation was made.
|
|
example: null
|
|
nullable: true
|
|
reasons:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: A list of reasons for the recommendation.
|
|
example:
|
|
- Reason 1
|
|
- Reason 2
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
description: The time at which the recommendation was recorded.
|
|
example: '2020-06-01T13:49:37.385Z'
|
|
comments:
|
|
type: string
|
|
description: Comments recorded when the decision was made
|
|
example: This user no longer needs access to this source
|
|
required:
|
|
- id
|
|
- decision
|
|
- bulk
|
|
minItems: 1
|
|
maxItems: 250
|
|
example:
|
|
- id: ef38f94347e94562b5bb8424a56396b5
|
|
decision: APPROVE
|
|
bulk: true
|
|
comments: This user still needs access to this source.
|
|
- id: ef38f94347e94562b5bb8424a56397d8
|
|
decision: APPROVE
|
|
bulk: true
|
|
comments: This user still needs access to this source too.
|
|
responses:
|
|
'200':
|
|
description: An identity campaign certification object
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1certifications/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/IdentityCertificationDto.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the identity campaign certification on which to make decisions
|
|
# ReviewDecision[] | A non-empty array of decisions to be made.
|
|
$ReviewDecision = @"{
|
|
"comments" : "This user no longer needs access to this source",
|
|
"decision" : "APPROVE",
|
|
"proposedEndDate" : "2017-07-11T18:45:37.098Z",
|
|
"recommendation" : {
|
|
"reasons" : [ "Reason 1", "Reason 2" ],
|
|
"recommendation" : "recommendation",
|
|
"timestamp" : "2020-06-01T13:49:37.385Z"
|
|
},
|
|
"id" : "ef38f94347e94562b5bb8424a56397d8",
|
|
"bulk" : true
|
|
}"@
|
|
|
|
|
|
# Decide on a Certification Item
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToReviewDecision -Json $ReviewDecision
|
|
Select-IdentityDecision-Id $Id -ReviewDecision $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Select-IdentityDecision -Id $Id -ReviewDecision $ReviewDecision
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Select-IdentityDecision"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/certifications/{id}/reassign:
|
|
post:
|
|
operationId: reassignIdentityCertifications
|
|
tags:
|
|
- Certifications
|
|
summary: Reassign Identities or Items
|
|
description: This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listIdentityCertifications
|
|
description: The identity campaign certification ID
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
reassign:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/AccessReviewReassignment/properties/reassign/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ReassignReference.yaml
|
|
reassignTo:
|
|
type: string
|
|
description: The ID of the identity to which the certification is reassigned
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
reason:
|
|
type: string
|
|
description: The reason comment for why the reassign was made
|
|
example: reassigned for some reason
|
|
required:
|
|
- reassign
|
|
- reassignTo
|
|
- reason
|
|
responses:
|
|
'200':
|
|
description: An identity campaign certification details after completing the reassignment.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1certifications/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/IdentityCertificationDto.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID
|
|
$ReviewReassign = @"
|
|
{
|
|
"reason" : "reassigned for some reason",
|
|
"reassignTo" : "ef38f94347e94562b5bb8424a56397d8",
|
|
"reassign" : [ {
|
|
"id" : "ef38f94347e94562b5bb8424a56397d8",
|
|
"type" : "ITEM"
|
|
}, {
|
|
"id" : "ef38f94347e94562b5bb8424a56397d8",
|
|
"type" : "ITEM"
|
|
} ]
|
|
}
|
|
"@
|
|
|
|
# Reassign Identities or Items
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign
|
|
Invoke-ReassignIdentityCertifications-Id $Id -ReviewReassign $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Invoke-ReassignIdentityCertifications -Id $Id -ReviewReassign $ReviewReassign
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-ReassignIdentityCertifications"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/certifications/{id}/sign-off:
|
|
post:
|
|
operationId: signOffIdentityCertification
|
|
tags:
|
|
- Certifications
|
|
summary: Finalize Identity Certification Decisions
|
|
security:
|
|
- userAuth: []
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- CERT_ADMIN
|
|
description: This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listIdentityCertifications
|
|
description: The identity campaign certification ID
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
responses:
|
|
'200':
|
|
description: An identity campaign certification object
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1certifications/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/IdentityCertificationDto.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID
|
|
|
|
# Finalize Identity Certification Decisions
|
|
|
|
try {
|
|
Invoke-SignOffIdentityCertification-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Invoke-SignOffIdentityCertification -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-SignOffIdentityCertification"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/certifications/{id}/decision-summary:
|
|
get:
|
|
operationId: getIdentityDecisionSummary
|
|
tags:
|
|
- Certification Summaries
|
|
summary: Summary of Certification Decisions
|
|
security:
|
|
- userAuth: []
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- CERT_ADMIN
|
|
description: This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. Reviewers for this certification can also call this API.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listIdentityCertifications
|
|
description: The certification ID
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
- in: query
|
|
name: filters
|
|
required: false
|
|
schema:
|
|
type: string
|
|
example: identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"
|
|
description: |-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
**identitySummary.id**: *eq, in*
|
|
responses:
|
|
'200':
|
|
description: Summary of the decisions made
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
entitlementDecisionsMade:
|
|
type: integer
|
|
description: Number of entitlement decisions that have been made
|
|
example: 3
|
|
format: int32
|
|
accessProfileDecisionsMade:
|
|
type: integer
|
|
description: Number of access profile decisions that have been made
|
|
example: 5
|
|
format: int32
|
|
roleDecisionsMade:
|
|
type: integer
|
|
description: Number of role decisions that have been made
|
|
example: 2
|
|
format: int32
|
|
accountDecisionsMade:
|
|
type: integer
|
|
description: Number of account decisions that have been made
|
|
example: 4
|
|
format: int32
|
|
entitlementDecisionsTotal:
|
|
type: integer
|
|
description: The total number of entitlement decisions on the certification, both complete and incomplete
|
|
example: 6
|
|
format: int32
|
|
accessProfileDecisionsTotal:
|
|
type: integer
|
|
description: The total number of access profile decisions on the certification, both complete and incomplete
|
|
example: 10
|
|
format: int32
|
|
roleDecisionsTotal:
|
|
type: integer
|
|
description: The total number of role decisions on the certification, both complete and incomplete
|
|
example: 4
|
|
format: int32
|
|
accountDecisionsTotal:
|
|
type: integer
|
|
description: The total number of account decisions on the certification, both complete and incomplete
|
|
example: 8
|
|
format: int32
|
|
entitlementsApproved:
|
|
type: integer
|
|
description: The number of entitlement decisions that have been made which were approved
|
|
example: 2
|
|
format: int32
|
|
entitlementsRevoked:
|
|
type: integer
|
|
description: The number of entitlement decisions that have been made which were revoked
|
|
example: 1
|
|
format: int32
|
|
accessProfilesApproved:
|
|
type: integer
|
|
description: The number of access profile decisions that have been made which were approved
|
|
example: 3
|
|
format: int32
|
|
accessProfilesRevoked:
|
|
type: integer
|
|
description: The number of access profile decisions that have been made which were revoked
|
|
example: 2
|
|
format: int32
|
|
rolesApproved:
|
|
type: integer
|
|
description: The number of role decisions that have been made which were approved
|
|
example: 2
|
|
format: int32
|
|
rolesRevoked:
|
|
type: integer
|
|
description: The number of role decisions that have been made which were revoked
|
|
example: 0
|
|
format: int32
|
|
accountsApproved:
|
|
type: integer
|
|
description: The number of account decisions that have been made which were approved
|
|
example: 1
|
|
format: int32
|
|
accountsRevoked:
|
|
type: integer
|
|
description: The number of account decisions that have been made which were revoked
|
|
example: 3
|
|
format: int32
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID
|
|
$Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional)
|
|
|
|
# Summary of Certification Decisions
|
|
|
|
try {
|
|
Get-IdentityDecisionSummary-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-IdentityDecisionSummary -Id $Id -Filters $Filters
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityDecisionSummary"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/certifications/{id}/identity-summaries:
|
|
get:
|
|
operationId: getIdentitySummaries
|
|
tags:
|
|
- Certification Summaries
|
|
summary: Identity Summaries for Campaign Certification
|
|
security:
|
|
- userAuth: []
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- CERT_ADMIN
|
|
description: This API returns a list of the identity summaries for a specific identity campaign certification. Reviewers for this certification can also call this API.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listIdentityCertifications
|
|
description: The identity campaign certification ID
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
- in: query
|
|
name: filters
|
|
required: false
|
|
schema:
|
|
type: string
|
|
example: id eq "ef38f94347e94562b5bb8424a56397d8"
|
|
description: |-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
**id**: *eq, in*
|
|
|
|
**completed**: *eq, ne*
|
|
|
|
**name**: *eq, sw*
|
|
- in: query
|
|
name: sorters
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: comma-separated
|
|
example: name
|
|
description: |-
|
|
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
|
|
|
Sorting is supported for the following fields: **name**
|
|
responses:
|
|
'200':
|
|
description: List of identity summaries
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The ID of the identity summary
|
|
example: 2c91808772a504f50172a9540e501ba7
|
|
name:
|
|
type: string
|
|
description: Name of the linked identity
|
|
example: Alison Ferguso
|
|
identityId:
|
|
type: string
|
|
description: The ID of the identity being certified
|
|
example: 2c9180857182306001719937377a33de
|
|
completed:
|
|
type: boolean
|
|
description: Indicates whether the review items for the linked identity's certification have been completed
|
|
example: true
|
|
example:
|
|
- id: 2c91808772a504f50172a9540e501ba7
|
|
name: Aaron Grey
|
|
identityId: 2c9180857182306001719937379633e4
|
|
completed: false
|
|
- id: 2c91808772a504f50172a9540e501ba8
|
|
name: Aglae Wilson
|
|
identityId: 2c9180857182306001719937377a33de
|
|
completed: true
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
$Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional)
|
|
$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional)
|
|
|
|
# Identity Summaries for Campaign Certification
|
|
|
|
try {
|
|
Get-IdentitySummaries-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-IdentitySummaries -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentitySummaries"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/certifications/{id}/access-summaries/{type}:
|
|
get:
|
|
operationId: getIdentityAccessSummaries
|
|
tags:
|
|
- Certification Summaries
|
|
summary: Access Summaries
|
|
description: This API returns a list of access summaries for the specified identity campaign certification and type. Reviewers for this certification can also call this API.
|
|
security:
|
|
- userAuth:
|
|
- idn:certification:read
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- CERT_ADMIN
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listIdentityCertifications
|
|
description: The identity campaign certification ID
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
- in: path
|
|
name: type
|
|
schema:
|
|
type: string
|
|
enum:
|
|
- ROLE
|
|
- ACCESS_PROFILE
|
|
- ENTITLEMENT
|
|
required: true
|
|
description: The type of access review item to retrieve summaries for
|
|
example: ACCESS_PROFILE
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
- in: query
|
|
name: filters
|
|
required: false
|
|
schema:
|
|
type: string
|
|
example: access.id eq "ef38f94347e94562b5bb8424a56397d8"
|
|
description: |-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
**completed**: *eq, ne*
|
|
|
|
**access.id**: *eq, in*
|
|
|
|
**access.name**: *eq, sw*
|
|
|
|
**entitlement.sourceName**: *eq, sw*
|
|
|
|
**accessProfile.sourceName**: *eq, sw*
|
|
- in: query
|
|
name: sorters
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: comma-separated
|
|
example: access.name
|
|
description: |-
|
|
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
|
|
|
Sorting is supported for the following fields: **access.name**
|
|
responses:
|
|
'200':
|
|
description: List of access summaries
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
description: An object holding the access that is being reviewed
|
|
properties:
|
|
access:
|
|
type: object
|
|
properties:
|
|
type:
|
|
$ref: '#/components/schemas/AccessProfileSummary/allOf/0/allOf/1/properties/type'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/DtoType.yaml
|
|
id:
|
|
type: string
|
|
description: The ID of the item being certified
|
|
example: 2c9180867160846801719932c5153fb7
|
|
name:
|
|
type: string
|
|
description: The name of the item being certified
|
|
example: Entitlement for Company Database
|
|
entitlement:
|
|
type: object
|
|
nullable: true
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The id for the entitlement
|
|
example: 2c918085718230600171993742c63558
|
|
name:
|
|
type: string
|
|
description: The name of the entitlement
|
|
example: CN=entitlement.bbb7c650
|
|
description:
|
|
nullable: true
|
|
type: string
|
|
description: Information about the entitlement
|
|
example: Gives read/write access to the company database
|
|
privileged:
|
|
type: boolean
|
|
example: false
|
|
default: false
|
|
description: Indicates if the entitlement is a privileged entitlement
|
|
owner:
|
|
$ref: '#/components/schemas/RequestableObject/properties/ownerRef'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/IdentityReferenceWithNameAndEmail.yaml
|
|
attributeName:
|
|
type: string
|
|
description: The name of the attribute on the source
|
|
example: memberOf
|
|
attributeValue:
|
|
type: string
|
|
description: The value of the attribute on the source
|
|
example: CN=entitlement.bbb7c650
|
|
sourceSchemaObjectType:
|
|
type: string
|
|
description: The schema object type on the source used to represent the entitlement and its attributes
|
|
example: groups
|
|
sourceName:
|
|
type: string
|
|
description: The name of the source for which this entitlement belongs
|
|
example: ODS-AD-Source
|
|
sourceType:
|
|
type: string
|
|
description: The type of the source for which the entitlement belongs
|
|
example: Active Directory - Direct
|
|
sourceId:
|
|
type: string
|
|
description: The ID of the source for which the entitlement belongs
|
|
example: 78ca6be511cb41fbb86dba2fcca7780c
|
|
hasPermissions:
|
|
type: boolean
|
|
default: false
|
|
description: Indicates if the entitlement has permissions
|
|
example: false
|
|
isPermission:
|
|
type: boolean
|
|
default: false
|
|
description: Indicates if the entitlement is a representation of an account permission
|
|
example: false
|
|
revocable:
|
|
type: boolean
|
|
default: false
|
|
description: Indicates whether the entitlement can be revoked
|
|
example: true
|
|
cloudGoverned:
|
|
type: boolean
|
|
default: false
|
|
description: True if the entitlement is cloud governed
|
|
example: false
|
|
containsDataAccess:
|
|
type: boolean
|
|
description: True if the entitlement has DAS data
|
|
default: false
|
|
example: true
|
|
dataAccess:
|
|
type: object
|
|
description: DAS data for the entitlement
|
|
nullable: true
|
|
properties:
|
|
policies:
|
|
type: array
|
|
description: List of classification policies that apply to resources the entitlement \ groups has access to
|
|
items:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
description: Value of the policy
|
|
example: GDPR-20
|
|
categories:
|
|
type: array
|
|
description: List of classification categories that apply to resources the entitlement \ groups has access to
|
|
items:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
description: Value of the category
|
|
example: email-7
|
|
matchCount:
|
|
type: integer
|
|
description: Number of matched for each category
|
|
example: 10
|
|
impactScore:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
description: Impact Score for this data
|
|
example: Medium
|
|
account:
|
|
type: object
|
|
nullable: true
|
|
description: Information about the status of the entitlement
|
|
properties:
|
|
nativeIdentity:
|
|
type: string
|
|
description: The native identity for this account
|
|
example: CN=Alison Ferguso
|
|
disabled:
|
|
type: boolean
|
|
default: false
|
|
example: false
|
|
description: Indicates whether this account is currently disabled
|
|
locked:
|
|
type: boolean
|
|
default: false
|
|
example: false
|
|
description: Indicates whether this account is currently locked
|
|
type:
|
|
$ref: '#/components/schemas/AccessProfileSummary/allOf/0/allOf/1/properties/type'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/DtoType.yaml
|
|
id:
|
|
nullable: true
|
|
type: string
|
|
description: The id associated with the account
|
|
example: 2c9180857182305e0171993737eb29e6
|
|
name:
|
|
nullable: true
|
|
type: string
|
|
description: The account name
|
|
example: Alison Ferguso
|
|
created:
|
|
nullable: true
|
|
type: string
|
|
format: date-time
|
|
description: When the account was created
|
|
example: '2020-04-20T20:11:05.067Z'
|
|
modified:
|
|
nullable: true
|
|
type: string
|
|
format: date-time
|
|
description: When the account was last modified
|
|
example: '2020-05-20T18:57:16.987Z'
|
|
activityInsights:
|
|
type: object
|
|
description: Insights into account activity
|
|
properties:
|
|
accountID:
|
|
type: string
|
|
description: UUID of the account
|
|
example: c4ddd5421d8549f0abd309162cafd3b1
|
|
usageDays:
|
|
type: integer
|
|
format: int32
|
|
minimum: 0
|
|
maximum: 90
|
|
description: The number of days of activity
|
|
example: 45
|
|
usageDaysState:
|
|
type: string
|
|
enum:
|
|
- COMPLETE
|
|
- UNKNOWN
|
|
description: Status indicating if the activity is complete or unknown
|
|
example: COMPLETE
|
|
description:
|
|
nullable: true
|
|
type: string
|
|
description: Information about the account
|
|
example: Account for Read/write to the company database
|
|
governanceGroupId:
|
|
nullable: true
|
|
type: string
|
|
description: The id associated with the machine Account Governance Group
|
|
example: 2c9180857182305e0171993737eb29e6
|
|
owner:
|
|
type: object
|
|
nullable: true
|
|
description: Information about the machine account owner
|
|
properties:
|
|
id:
|
|
nullable: true
|
|
type: string
|
|
description: The id associated with the machine account owner
|
|
example: 2c9180857182305e0171993737eb29e8
|
|
type:
|
|
type: string
|
|
enum:
|
|
- IDENTITY
|
|
description: An enumeration of the types of Owner supported within the IdentityNow infrastructure.
|
|
example: IDENTITY
|
|
displayName:
|
|
nullable: true
|
|
type: string
|
|
description: The machine account owner's display name
|
|
example: Alison Ferguson
|
|
accessProfile:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The id of the Access Profile
|
|
example: 2c91808a7190d06e01719938fcd20792
|
|
name:
|
|
type: string
|
|
description: Name of the Access Profile
|
|
example: Employee-database-read-write
|
|
description:
|
|
type: string
|
|
description: Information about the Access Profile
|
|
example: Collection of entitlements to read/write the employee database
|
|
privileged:
|
|
type: boolean
|
|
description: Indicates if the entitlement is a privileged entitlement
|
|
example: false
|
|
cloudGoverned:
|
|
type: boolean
|
|
description: True if the entitlement is cloud governed
|
|
example: false
|
|
endDate:
|
|
nullable: true
|
|
type: string
|
|
format: date-time
|
|
description: The date at which a user's access expires
|
|
example: '2021-12-25T00:00:00.000Z'
|
|
owner:
|
|
$ref: '#/components/schemas/RequestableObject/properties/ownerRef'
|
|
description: Owner of the Access Profile
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/IdentityReferenceWithNameAndEmail.yaml
|
|
entitlements:
|
|
type: array
|
|
description: A list of entitlements associated with this Access Profile
|
|
items:
|
|
$ref: '#/paths/~1certifications~1%7Bid%7D~1access-summaries~1%7Btype%7D/get/responses/200/content/application~1json/schema/items/properties/entitlement'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/reviews/ReviewableEntitlement.yaml
|
|
created:
|
|
type: string
|
|
description: Date the Access Profile was created.
|
|
format: date-time
|
|
example: '2021-01-01T22:32:58.104Z'
|
|
modified:
|
|
type: string
|
|
description: Date the Access Profile was last modified.
|
|
format: date-time
|
|
example: '2021-02-01T22:32:58.104Z'
|
|
role:
|
|
type: object
|
|
nullable: true
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The id for the Role
|
|
example: 2c91808a7190d06e0171993907fd0794
|
|
name:
|
|
type: string
|
|
description: The name of the Role
|
|
example: Accounting-Employees
|
|
description:
|
|
type: string
|
|
description: Information about the Role
|
|
example: Role for members of the accounting department with the necessary Access Profiles
|
|
privileged:
|
|
type: boolean
|
|
description: Indicates if the entitlement is a privileged entitlement
|
|
example: false
|
|
owner:
|
|
$ref: '#/components/schemas/RequestableObject/properties/ownerRef'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/IdentityReferenceWithNameAndEmail.yaml
|
|
revocable:
|
|
type: boolean
|
|
description: Indicates whether the Role can be revoked or requested
|
|
example: false
|
|
endDate:
|
|
type: string
|
|
format: date-time
|
|
description: The date when a user's access expires.
|
|
example: '2021-12-25T00:00:00.000Z'
|
|
accessProfiles:
|
|
type: array
|
|
description: The list of Access Profiles associated with this Role
|
|
items:
|
|
$ref: '#/paths/~1certifications~1%7Bid%7D~1access-summaries~1%7Btype%7D/get/responses/200/content/application~1json/schema/items/properties/accessProfile'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/reviews/ReviewableAccessProfile.yaml
|
|
entitlements:
|
|
type: array
|
|
description: The list of entitlements associated with this Role
|
|
items:
|
|
$ref: '#/paths/~1certifications~1%7Bid%7D~1access-summaries~1%7Btype%7D/get/responses/200/content/application~1json/schema/items/properties/entitlement'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/reviews/ReviewableEntitlement.yaml
|
|
example:
|
|
- access:
|
|
type: ENTITLEMENT
|
|
id: 2c9180857182305e01719937429e2bad
|
|
name: CN=Engineering
|
|
entitlement:
|
|
id: 2c9180857182305e01719937429e2bad
|
|
name: CN=Engineering
|
|
description: Access to the engineering database
|
|
privileged: false
|
|
owner:
|
|
email: brandon.gray@acme-solar.com
|
|
type: IDENTITY
|
|
id: 2c9180867160846801719932c5153fb7
|
|
name: Brandon Gray
|
|
attributeName: memberOf
|
|
attributeValue: CN=Engineering
|
|
sourceName: ODS-AD-Source
|
|
hasPermissions: true
|
|
revocable: true
|
|
containsDataAccess: true
|
|
dataAccess:
|
|
policies:
|
|
- value: GDPR-1
|
|
- value: GDPR-2
|
|
categories:
|
|
- value: email-7
|
|
matchCount: 74
|
|
- value: email-9
|
|
matchCount: 30
|
|
impactScore:
|
|
value: Medium
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID
|
|
$Type = "ROLE" # String | The type of access review item to retrieve summaries for
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
$Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional)
|
|
$Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional)
|
|
|
|
# Access Summaries
|
|
|
|
try {
|
|
Get-IdentityAccessSummaries-Id $Id -Type $Type
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityAccessSummaries"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/certifications/{id}/identity-summaries/{identitySummaryId}:
|
|
get:
|
|
operationId: getIdentitySummary
|
|
tags:
|
|
- Certification Summaries
|
|
summary: Summary for Identity
|
|
security:
|
|
- userAuth: []
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- CERT_ADMIN
|
|
description: This API returns the summary for an identity on a specified identity campaign certification. Reviewers for this certification can also call this API.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listIdentityCertifications
|
|
description: The identity campaign certification ID
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
- in: path
|
|
name: identitySummaryId
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getIdentitySummaries
|
|
description: The identity summary ID
|
|
example: 2c91808772a504f50172a9540e501ba8
|
|
responses:
|
|
'200':
|
|
description: An identity summary
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1certifications~1%7Bid%7D~1identity-summaries/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/CertificationIdentitySummary.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID
|
|
$IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID
|
|
|
|
# Summary for Identity
|
|
|
|
try {
|
|
Get-IdentitySummary-Id $Id -IdentitySummaryId $IdentitySummaryId
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentitySummary"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/certifications/{certificationId}/access-review-items/{itemId}/permissions:
|
|
get:
|
|
operationId: getIdentityCertificationItemPermissions
|
|
tags:
|
|
- Certifications
|
|
summary: Permissions for Entitlement Certification Item
|
|
description: This API returns the permissions associated with an entitlement certification item based on the certification item's ID. Reviewers for this certification can also call this API.
|
|
security:
|
|
- userAuth:
|
|
- idn:certification:read
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- CERT_ADMIN
|
|
parameters:
|
|
- in: query
|
|
name: filters
|
|
schema:
|
|
type: string
|
|
description: |-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
**target**: *eq, sw*
|
|
|
|
**rights**: *ca*
|
|
|
|
Supported composite operators: *and, or*
|
|
|
|
All field values (second filter operands) are case-insensitive for this API.
|
|
|
|
Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field.
|
|
|
|
For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22`
|
|
|
|
The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1
|
|
example: target eq "SYS.OBJAUTH2"
|
|
- in: path
|
|
name: certificationId
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listIdentityCertifications
|
|
description: The certification ID
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
- in: path
|
|
name: itemId
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listIdentityAccessReviewItems
|
|
description: The certification item ID
|
|
example: 2c91808671bcbab40171bd945d961227
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
responses:
|
|
'200':
|
|
description: A list of permissions associated with the given itemId
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
description: Simplified DTO for the Permission objects stored in SailPoint's database. The data is aggregated from customer systems and is free-form, so its appearance can vary largely between different clients/customers.
|
|
properties:
|
|
rights:
|
|
type: array
|
|
description: All the rights (e.g. actions) that this permission allows on the target
|
|
readOnly: true
|
|
items:
|
|
type: string
|
|
example: SELECT
|
|
target:
|
|
type: string
|
|
description: The target the permission would grants rights on.
|
|
readOnly: true
|
|
example: SYS.GV_$TRANSACTION
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$CertificationId = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID
|
|
$ItemId = "2c91808671bcbab40171bd945d961227" # String | The certification item ID
|
|
$Filters = "target eq "SYS.OBJAUTH2"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 (optional)
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
|
|
# Permissions for Entitlement Certification Item
|
|
|
|
try {
|
|
Get-IdentityCertificationItemPermissions-CertificationId $CertificationId -ItemId $ItemId
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-IdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityCertificationItemPermissions"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/certifications/{id}/reviewers:
|
|
get:
|
|
operationId: listCertificationReviewers
|
|
tags:
|
|
- Certifications
|
|
summary: List of Reviewers for certification
|
|
description: This API returns a list of reviewers for the certification. Reviewers for this certification can also call this API.
|
|
security:
|
|
- userAuth:
|
|
- idn:certification:read
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- CERT_ADMIN
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listIdentityCertifications
|
|
description: The certification ID
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
- in: query
|
|
name: filters
|
|
schema:
|
|
type: string
|
|
description: |-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
**id**: *eq, in*
|
|
|
|
**name**: *eq, sw*
|
|
|
|
**email**: *eq, sw*
|
|
example: name eq "Bob"
|
|
- in: query
|
|
name: sorters
|
|
schema:
|
|
type: string
|
|
format: comma-separated
|
|
description: |-
|
|
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
|
|
|
Sorting is supported for the following fields: **name, email**
|
|
example: name
|
|
responses:
|
|
'200':
|
|
description: A list of reviewers
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/RequestableObject/properties/ownerRef'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/IdentityReferenceWithNameAndEmail.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
$Filters = "name eq "Bob"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **email**: *eq, sw* (optional)
|
|
$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, email** (optional)
|
|
|
|
# List of Reviewers for certification
|
|
|
|
try {
|
|
Get-CertificationReviewers-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-CertificationReviewers -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CertificationReviewers"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/certifications/{id}/reassign-async:
|
|
post:
|
|
operationId: submitReassignCertsAsync
|
|
tags:
|
|
- Certifications
|
|
summary: Reassign Certifications Asynchronously
|
|
description: |
|
|
This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another
|
|
reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the
|
|
reassignment is complete.
|
|
|
|
Reviewers for this certification can also call this API.
|
|
security:
|
|
- userAuth:
|
|
- idn:campaign:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- CERT_ADMIN
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listIdentityCertifications
|
|
description: The identity campaign certification ID
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1certifications~1%7Bid%7D~1reassign/post/requestBody/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ReviewReassign.yaml
|
|
responses:
|
|
'200':
|
|
description: A certification task object for the reassignment which can be queried for status.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1campaigns~1%7Bid%7D~1reassign/post/responses/202/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/CertificationTask.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID
|
|
$ReviewReassign = @"
|
|
{
|
|
"reason" : "reassigned for some reason",
|
|
"reassignTo" : "ef38f94347e94562b5bb8424a56397d8",
|
|
"reassign" : [ {
|
|
"id" : "ef38f94347e94562b5bb8424a56397d8",
|
|
"type" : "ITEM"
|
|
}, {
|
|
"id" : "ef38f94347e94562b5bb8424a56397d8",
|
|
"type" : "ITEM"
|
|
} ]
|
|
}
|
|
"@
|
|
|
|
# Reassign Certifications Asynchronously
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign
|
|
Submit-ReassignCertsAsync-Id $Id -ReviewReassign $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Submit-ReassignCertsAsync -Id $Id -ReviewReassign $ReviewReassign
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-ReassignCertsAsync"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/certification-tasks/{id}:
|
|
get:
|
|
operationId: getCertificationTask
|
|
tags:
|
|
- Certifications
|
|
summary: Certification Task by ID
|
|
description: This API returns the certification task for the specified ID. Reviewers for the specified certification can also call this API.
|
|
security:
|
|
- userAuth:
|
|
- idn:certification:read
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- CERT_ADMIN
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getPendingCertificationTasks
|
|
description: The task ID
|
|
example: 63b32151-26c0-42f4-9299-8898dc1c9daa
|
|
responses:
|
|
'200':
|
|
description: A certification task
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1campaigns~1%7Bid%7D~1reassign/post/responses/202/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/CertificationTask.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "63b32151-26c0-42f4-9299-8898dc1c9daa" # String | The task ID
|
|
|
|
# Certification Task by ID
|
|
|
|
try {
|
|
Get-CertificationTask-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-CertificationTask -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CertificationTask"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/certification-tasks:
|
|
get:
|
|
operationId: getPendingCertificationTasks
|
|
tags:
|
|
- Certifications
|
|
summary: List of Pending Certification Tasks
|
|
description: This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned.
|
|
security:
|
|
- userAuth:
|
|
- idn:certification:read
|
|
parameters:
|
|
- in: query
|
|
name: reviewer-identity
|
|
schema:
|
|
type: string
|
|
example: Ada.1de82e55078344
|
|
description: The ID of reviewer identity. *me* indicates the current user.
|
|
required: false
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
- in: query
|
|
name: filters
|
|
schema:
|
|
type: string
|
|
example: type eq "ADMIN_REASSIGN"
|
|
description: |-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
**id**: *eq, in*
|
|
|
|
**targetId**: *eq, in*
|
|
|
|
**type**: *eq, in*
|
|
responses:
|
|
'200':
|
|
description: A list of pending certification tasks
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1campaigns~1%7Bid%7D~1reassign/post/responses/202/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/CertificationTask.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$ReviewerIdentity = "Ada.1de82e55078344" # String | The ID of reviewer identity. *me* indicates the current user. (optional)
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
$Filters = "type eq "ADMIN_REASSIGN"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **targetId**: *eq, in* **type**: *eq, in* (optional)
|
|
|
|
# List of Pending Certification Tasks
|
|
|
|
try {
|
|
Get-PendingCertificationTasks
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-PendingCertificationTasks -ReviewerIdentity $ReviewerIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PendingCertificationTasks"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/configuration-hub/object-mappings/{sourceOrg}:
|
|
get:
|
|
operationId: getObjectMappings
|
|
security:
|
|
- userAuth:
|
|
- sp:config-object-mapping:read
|
|
- sp:config-object-mapping:manage
|
|
tags:
|
|
- Configuration Hub
|
|
summary: Gets list of object mappings
|
|
description: |-
|
|
This gets a list of existing object mappings between current org and source org.
|
|
Source org should be "default" when getting object mappings that are not associated to any particular org.
|
|
The request will need the following security scope:
|
|
- sp:config-object-mapping:read
|
|
parameters:
|
|
- in: path
|
|
name: sourceOrg
|
|
schema:
|
|
type: string
|
|
required: true
|
|
description: The name of the source org.
|
|
example: source-org
|
|
responses:
|
|
'200':
|
|
description: List of existing object mappings between current org and source org.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
title: Object Mapping Response
|
|
properties:
|
|
objectMappingId:
|
|
type: string
|
|
description: Id of the object mapping
|
|
example: 3d6e0144-963f-4bd6-8d8d-d77b4e507ce4
|
|
objectType:
|
|
type: string
|
|
description: Type of the object the mapping value applies to
|
|
example: IDENTITY
|
|
enum:
|
|
- ACCESS_PROFILE
|
|
- ACCESS_REQUEST_CONFIG
|
|
- ATTR_SYNC_SOURCE_CONFIG
|
|
- AUTH_ORG
|
|
- CAMPAIGN_FILTER
|
|
- ENTITLEMENT
|
|
- FORM_DEFINITION
|
|
- GOVERNANCE_GROUP
|
|
- IDENTITY
|
|
- IDENTITY_OBJECT_CONFIG
|
|
- IDENTITY_PROFILE
|
|
- LIFECYCLE_STATE
|
|
- NOTIFICATION_TEMPLATE
|
|
- PASSWORD_POLICY
|
|
- PASSWORD_SYNC_GROUP
|
|
- PUBLIC_IDENTITIES_CONFIG
|
|
- ROLE
|
|
- RULE
|
|
- SEGMENT
|
|
- SERVICE_DESK_INTEGRATION
|
|
- SOD_POLICY
|
|
- SOURCE
|
|
- TAG
|
|
- TRANSFORM
|
|
- TRIGGER_SUBSCRIPTION
|
|
- WORKFLOW
|
|
jsonPath:
|
|
type: string
|
|
description: JSONPath expression denoting the path within the object where the mapping value should be applied
|
|
example: $.name
|
|
sourceValue:
|
|
type: string
|
|
description: Original value at the jsonPath location within the object
|
|
example: My Governance Group Name
|
|
targetValue:
|
|
type: string
|
|
description: Value to be assigned at the jsonPath location within the object
|
|
example: My New Governance Group Name
|
|
enabled:
|
|
type: boolean
|
|
description: Whether or not this object mapping is enabled
|
|
default: false
|
|
example: false
|
|
created:
|
|
type: string
|
|
description: Object mapping creation timestamp
|
|
example: '2024-03-19T23:18:53.732Z'
|
|
modified:
|
|
type: string
|
|
description: Object mapping latest update timestamp
|
|
example: '2024-03-19T23:18:53.732Z'
|
|
example:
|
|
- objectMappingId: 3d6e0144-963f-4bd6-8d8d-d77b4e507ce4
|
|
objectType: GOVERNANCE_GROUP
|
|
jsonPath: $.description
|
|
sourceValue: Sample Governance Group
|
|
targetValue: Sample Governance Group - Updated
|
|
enabled: true
|
|
created: '2024-03-19T23:18:53.732Z'
|
|
modified: '2024-03-19T23:18:53.732Z'
|
|
- objectMappingId: e1d5cb80-65e2-4f92-ae2e-9588f61cc4cd
|
|
objectType: IDENTITY
|
|
jsonPath: $.name
|
|
sourceValue: SailPoint Support
|
|
targetValue: john.doe
|
|
enabled: false
|
|
created: '2024-03-19T23:18:06.238Z'
|
|
modified: '2024-03-19T23:18:06.238Z'
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$SourceOrg = "source-org" # String | The name of the source org.
|
|
|
|
# Gets list of object mappings
|
|
|
|
try {
|
|
Get-ObjectMappings-SourceOrg $SourceOrg
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-ObjectMappings -SourceOrg $SourceOrg
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ObjectMappings"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
post:
|
|
operationId: createObjectMapping
|
|
security:
|
|
- userAuth:
|
|
- sp:config-object-mapping:manage
|
|
tags:
|
|
- Configuration Hub
|
|
summary: Creates an object mapping
|
|
description: |-
|
|
This creates an object mapping between current org and source org.
|
|
Source org should be "default" when creating an object mapping that is not to be associated to any particular org.
|
|
The request will need the following security scope:
|
|
- sp:config-object-mapping:manage
|
|
parameters:
|
|
- in: path
|
|
name: sourceOrg
|
|
schema:
|
|
type: string
|
|
required: true
|
|
description: The name of the source org.
|
|
example: source-org
|
|
requestBody:
|
|
description: The object mapping request body.
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: Object Mapping Request
|
|
required:
|
|
- objectType
|
|
- jsonPath
|
|
- sourceValue
|
|
- targetValue
|
|
properties:
|
|
objectType:
|
|
type: string
|
|
description: Type of the object the mapping value applies to, must be one from enum
|
|
example: IDENTITY
|
|
enum:
|
|
- ACCESS_PROFILE
|
|
- ACCESS_REQUEST_CONFIG
|
|
- ATTR_SYNC_SOURCE_CONFIG
|
|
- AUTH_ORG
|
|
- CAMPAIGN_FILTER
|
|
- ENTITLEMENT
|
|
- FORM_DEFINITION
|
|
- GOVERNANCE_GROUP
|
|
- IDENTITY
|
|
- IDENTITY_OBJECT_CONFIG
|
|
- IDENTITY_PROFILE
|
|
- LIFECYCLE_STATE
|
|
- NOTIFICATION_TEMPLATE
|
|
- PASSWORD_POLICY
|
|
- PASSWORD_SYNC_GROUP
|
|
- PUBLIC_IDENTITIES_CONFIG
|
|
- ROLE
|
|
- RULE
|
|
- SEGMENT
|
|
- SERVICE_DESK_INTEGRATION
|
|
- SOD_POLICY
|
|
- SOURCE
|
|
- TAG
|
|
- TRANSFORM
|
|
- TRIGGER_SUBSCRIPTION
|
|
- WORKFLOW
|
|
jsonPath:
|
|
type: string
|
|
description: JSONPath expression denoting the path within the object where the mapping value should be applied
|
|
example: $.name
|
|
sourceValue:
|
|
type: string
|
|
description: Original value at the jsonPath location within the object
|
|
example: My Governance Group Name
|
|
targetValue:
|
|
type: string
|
|
description: Value to be assigned at the jsonPath location within the object
|
|
example: My New Governance Group Name
|
|
enabled:
|
|
type: boolean
|
|
description: Whether or not this object mapping is enabled
|
|
default: false
|
|
example: false
|
|
example:
|
|
objectType: GOVERNANCE_GROUP
|
|
jsonPath: $.description
|
|
sourceValue: Sample Governance Group
|
|
targetValue: Sample Governance Group - Updated
|
|
enabled: true
|
|
responses:
|
|
'200':
|
|
description: The created object mapping between current org and source org.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1configuration-hub~1object-mappings~1%7BsourceOrg%7D/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/configuration-hub/ObjectMappingResponse.yaml
|
|
example:
|
|
objectMappingId: 3d6e0144-963f-4bd6-8d8d-d77b4e507ce4
|
|
objectType: GOVERNANCE_GROUP
|
|
jsonPath: $.description
|
|
sourceValue: Sample Governance Group
|
|
targetValue: Sample Governance Group - Updated
|
|
enabled: true
|
|
created: '2024-03-19T23:18:53.732Z'
|
|
modified: '2024-03-19T23:18:53.732Z'
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$SourceOrg = "source-org" # String | The name of the source org.
|
|
$ObjectMappingRequest = @"
|
|
{
|
|
"targetValue" : "My New Governance Group Name",
|
|
"jsonPath" : "$.name",
|
|
"sourceValue" : "My Governance Group Name",
|
|
"enabled" : false,
|
|
"objectType" : "IDENTITY"
|
|
}
|
|
"@
|
|
|
|
# Creates an object mapping
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToObjectMappingRequest -Json $ObjectMappingRequest
|
|
New-ObjectMapping-SourceOrg $SourceOrg -ObjectMappingRequest $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# New-ObjectMapping -SourceOrg $SourceOrg -ObjectMappingRequest $ObjectMappingRequest
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ObjectMapping"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/configuration-hub/object-mappings/{sourceOrg}/{objectMappingId}:
|
|
delete:
|
|
operationId: deleteObjectMapping
|
|
security:
|
|
- userAuth:
|
|
- sp:config-object-mapping:manage
|
|
tags:
|
|
- Configuration Hub
|
|
summary: Deletes an object mapping
|
|
description: |-
|
|
This deletes an existing object mapping.
|
|
Source org should be "default" when deleting an object mapping that is not associated to any particular org.
|
|
The request will need the following security scope:
|
|
- sp:config-object-mapping:manage
|
|
parameters:
|
|
- in: path
|
|
name: sourceOrg
|
|
schema:
|
|
type: string
|
|
required: true
|
|
description: The name of the source org.
|
|
example: source-org
|
|
- in: path
|
|
name: objectMappingId
|
|
schema:
|
|
type: string
|
|
required: true
|
|
description: The id of the object mapping to be deleted.
|
|
example: 3d6e0144-963f-4bd6-8d8d-d77b4e507ce4
|
|
responses:
|
|
'204':
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/204.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$SourceOrg = "source-org" # String | The name of the source org.
|
|
$ObjectMappingId = "3d6e0144-963f-4bd6-8d8d-d77b4e507ce4" # String | The id of the object mapping to be deleted.
|
|
|
|
# Deletes an object mapping
|
|
|
|
try {
|
|
Remove-ObjectMapping-SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Remove-ObjectMapping -SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ObjectMapping"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/configuration-hub/object-mappings/{sourceOrg}/bulk-create:
|
|
post:
|
|
operationId: createObjectMappings
|
|
security:
|
|
- userAuth:
|
|
- sp:config-object-mapping:manage
|
|
tags:
|
|
- Configuration Hub
|
|
summary: Bulk creates object mappings
|
|
description: |-
|
|
This creates a set of object mappings (Max 25) between current org and source org.
|
|
Source org should be "default" when creating object mappings that are not to be associated to any particular org.
|
|
The request will need the following security scope:
|
|
- sp:config-object-mapping:manage
|
|
parameters:
|
|
- in: path
|
|
name: sourceOrg
|
|
schema:
|
|
type: string
|
|
required: true
|
|
description: The name of the source org.
|
|
example: source-org
|
|
requestBody:
|
|
description: The bulk create object mapping request body.
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: Bulk Create Object Mapping Request
|
|
required:
|
|
- newObjectsMappings
|
|
properties:
|
|
newObjectsMappings:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1configuration-hub~1object-mappings~1%7BsourceOrg%7D/post/requestBody/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/configuration-hub/ObjectMappingRequest.yaml
|
|
example:
|
|
newObjectsMappings:
|
|
- objectType: SOURCE
|
|
jsonPath: $.name
|
|
sourceValue: Original SOURCE Name
|
|
targetValue: New SOURCE Name
|
|
enabled: true
|
|
- objectType: IDENTITY
|
|
jsonPath: $.name
|
|
sourceValue: Original IDENTITY Name
|
|
targetValue: 'New IDENTITY Name '
|
|
enabled: true
|
|
responses:
|
|
'200':
|
|
description: The created object mapping between current org and source org.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: Bulk Create Object Mapping Response
|
|
properties:
|
|
addedObjects:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1configuration-hub~1object-mappings~1%7BsourceOrg%7D/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/configuration-hub/ObjectMappingResponse.yaml
|
|
example:
|
|
addedObjects:
|
|
- objectMappingId: 603b1a61-d03d-4ed1-864f-a508fbd1995d
|
|
objectType: SOURCE
|
|
jsonPath: $.name
|
|
sourceValue: Original SOURCE Name
|
|
targetValue: New SOURCE Name
|
|
enabled: true
|
|
created: '2024-03-25T15:50:41.314Z'
|
|
modified: '2024-03-25T15:50:41.299Z'
|
|
- objectMappingId: 00bece34-f50d-4227-8878-76f620b5a971
|
|
objectType: IDENTITY
|
|
jsonPath: $.name
|
|
sourceValue: Original IDENTITY Name
|
|
targetValue: 'New IDENTITY Name '
|
|
enabled: true
|
|
created: '2024-03-25T15:50:41.316Z'
|
|
modified: '2024-03-25T15:50:41.316Z'
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$SourceOrg = "source-org" # String | The name of the source org.
|
|
$ObjectMappingBulkCreateRequest = @"
|
|
{
|
|
"newObjectsMappings" : [ {
|
|
"targetValue" : "My New Governance Group Name",
|
|
"jsonPath" : "$.name",
|
|
"sourceValue" : "My Governance Group Name",
|
|
"enabled" : false,
|
|
"objectType" : "IDENTITY"
|
|
}, {
|
|
"targetValue" : "My New Governance Group Name",
|
|
"jsonPath" : "$.name",
|
|
"sourceValue" : "My Governance Group Name",
|
|
"enabled" : false,
|
|
"objectType" : "IDENTITY"
|
|
} ]
|
|
}
|
|
"@
|
|
|
|
# Bulk creates object mappings
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToObjectMappingBulkCreateRequest -Json $ObjectMappingBulkCreateRequest
|
|
New-ObjectMappings-SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# New-ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $ObjectMappingBulkCreateRequest
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ObjectMappings"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/configuration-hub/object-mappings/{sourceOrg}/bulk-patch:
|
|
post:
|
|
operationId: updateObjectMappings
|
|
security:
|
|
- userAuth:
|
|
- sp:config-object-mapping:manage
|
|
tags:
|
|
- Configuration Hub
|
|
summary: Bulk updates object mappings
|
|
description: |-
|
|
This updates a set of object mappings, only enabled and targetValue fields can be updated.
|
|
Source org should be "default" when updating object mappings that are not associated to any particular org.
|
|
The request will need the following security scope:
|
|
- sp:config-object-mapping:manage
|
|
parameters:
|
|
- in: path
|
|
name: sourceOrg
|
|
schema:
|
|
type: string
|
|
required: true
|
|
description: The name of the source org.
|
|
example: source-org
|
|
requestBody:
|
|
description: The object mapping request body.
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: Bulk Update Object Mapping Request
|
|
required:
|
|
- patches
|
|
properties:
|
|
patches:
|
|
description: Map of id of the object mapping to a JsonPatchOperation describing what to patch on that object mapping.
|
|
type: object
|
|
additionalProperties:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/JsonPatchOperation.yaml
|
|
example:
|
|
603b1a61-d03d-4ed1-864f-a508fbd1995d:
|
|
- op: replace
|
|
path: /enabled
|
|
value: true
|
|
00bece34-f50d-4227-8878-76f620b5a971:
|
|
- op: replace
|
|
path: /targetValue
|
|
value: New Target Value
|
|
example:
|
|
patches:
|
|
603b1a61-d03d-4ed1-864f-a508fbd1995d:
|
|
- op: replace
|
|
path: /enabled
|
|
value: true
|
|
00bece34-f50d-4227-8878-76f620b5a971:
|
|
- op: replace
|
|
path: /targetValue
|
|
value: New Target Value
|
|
responses:
|
|
'200':
|
|
description: The updated object mappings.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: Bulk Update Object Mapping Response
|
|
properties:
|
|
patchedObjects:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1configuration-hub~1object-mappings~1%7BsourceOrg%7D/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/configuration-hub/ObjectMappingResponse.yaml
|
|
example:
|
|
patchedObjects:
|
|
- objectMappingId: 603b1a61-d03d-4ed1-864f-a508fbd1995d
|
|
objectType: SOURCE
|
|
jsonPath: $.name
|
|
sourceValue: Original SOURCE Name
|
|
targetValue: New SOURCE Name
|
|
enabled: true
|
|
created: '2024-03-25T15:50:41.314Z'
|
|
modified: '2024-03-25T15:50:41.299Z'
|
|
- objectMappingId: 00bece34-f50d-4227-8878-76f620b5a971
|
|
objectType: IDENTITY
|
|
jsonPath: $.name
|
|
sourceValue: Original IDENTITY Name
|
|
targetValue: 'New IDENTITY Name '
|
|
enabled: true
|
|
created: '2024-03-25T15:50:41.316Z'
|
|
modified: '2024-03-25T15:50:41.316Z'
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$SourceOrg = "source-org" # String | The name of the source org.
|
|
$ObjectMappingBulkPatchRequest = @"
|
|
{
|
|
"patches" : {
|
|
"603b1a61-d03d-4ed1-864f-a508fbd1995d" : [ {
|
|
"op" : "replace",
|
|
"path" : "/enabled",
|
|
"value" : true
|
|
} ],
|
|
"00bece34-f50d-4227-8878-76f620b5a971" : [ {
|
|
"op" : "replace",
|
|
"path" : "/targetValue",
|
|
"value" : "New Target Value"
|
|
} ]
|
|
}
|
|
}
|
|
"@
|
|
|
|
# Bulk updates object mappings
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToObjectMappingBulkPatchRequest -Json $ObjectMappingBulkPatchRequest
|
|
Update-ObjectMappings-SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Update-ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $ObjectMappingBulkPatchRequest
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ObjectMappings"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/configuration-hub/backups/uploads:
|
|
get:
|
|
operationId: listUploadedConfigurations
|
|
security:
|
|
- userAuth:
|
|
- sp:config-backup:read
|
|
- sp:config-backup:manage
|
|
tags:
|
|
- Configuration Hub
|
|
summary: List Uploaded Configurations
|
|
description: This API gets a list of existing uploaded configurations for the current tenant.
|
|
parameters:
|
|
- in: query
|
|
name: filters
|
|
schema:
|
|
type: string
|
|
description: |-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
**status**: *eq*
|
|
example: status eq "COMPLETE"
|
|
required: false
|
|
responses:
|
|
'200':
|
|
description: List of existing uploaded configurations.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
jobId:
|
|
type: string
|
|
description: Unique id assigned to this backup.
|
|
example: 3469b87d-48ca-439a-868f-2160001da8c1
|
|
status:
|
|
type: string
|
|
description: Status of the backup.
|
|
enum:
|
|
- NOT_STARTED
|
|
- IN_PROGRESS
|
|
- COMPLETE
|
|
- CANCELLED
|
|
- FAILED
|
|
example: COMPLETE
|
|
type:
|
|
type: string
|
|
description: Type of the job, will always be BACKUP for this type of job.
|
|
enum:
|
|
- BACKUP
|
|
example: BACKUP
|
|
tenant:
|
|
type: string
|
|
description: The name of the tenant performing the upload
|
|
example: tenant-name
|
|
requesterName:
|
|
type: string
|
|
description: The name of the requester.
|
|
example: Requester Name
|
|
fileExists:
|
|
type: boolean
|
|
default: true
|
|
description: Whether or not a file was created and stored for this backup.
|
|
example: true
|
|
created:
|
|
type: string
|
|
format: date-time
|
|
description: The time the job was started.
|
|
example: '2021-05-11T22:23:16.000Z'
|
|
modified:
|
|
type: string
|
|
format: date-time
|
|
description: The time of the last update to the job.
|
|
example: '2021-05-11T22:23:16.000Z'
|
|
completed:
|
|
type: string
|
|
format: date-time
|
|
description: The time the job was completed.
|
|
example: '2021-05-11T22:23:16.000Z'
|
|
name:
|
|
type: string
|
|
description: The name assigned to the upload file in the request body.
|
|
example: Backup Name
|
|
userCanDelete:
|
|
type: boolean
|
|
default: true
|
|
description: Whether this backup can be deleted by a regular user.
|
|
example: false
|
|
isPartial:
|
|
type: boolean
|
|
default: false
|
|
description: Whether this backup contains all supported object types or only some of them.
|
|
example: false
|
|
backupType:
|
|
type: string
|
|
description: |-
|
|
Denotes how this backup was created.
|
|
- MANUAL - The backup was created by a user.
|
|
- AUTOMATED - The backup was created by devops.
|
|
- AUTOMATED_DRAFT - The backup was created during a draft process.
|
|
- UPLOADED - The backup was created by uploading an existing configuration file.
|
|
enum:
|
|
- UPLOADED
|
|
- AUTOMATED
|
|
- MANUAL
|
|
example: MANUAL
|
|
options:
|
|
type: object
|
|
nullable: true
|
|
description: Backup options control what will be included in the backup.
|
|
properties:
|
|
includeTypes:
|
|
type: array
|
|
description: Object type names to be included in a Configuration Hub backup command.
|
|
items:
|
|
type: string
|
|
enum:
|
|
- ACCESS_PROFILE
|
|
- ACCESS_REQUEST_CONFIG
|
|
- ATTR_SYNC_SOURCE_CONFIG
|
|
- AUTH_ORG
|
|
- CAMPAIGN_FILTER
|
|
- FORM_DEFINITION
|
|
- GOVERNANCE_GROUP
|
|
- IDENTITY_OBJECT_CONFIG
|
|
- IDENTITY_PROFILE
|
|
- LIFECYCLE_STATE
|
|
- NOTIFICATION_TEMPLATE
|
|
- PASSWORD_POLICY
|
|
- PASSWORD_SYNC_GROUP
|
|
- PUBLIC_IDENTITIES_CONFIG
|
|
- ROLE
|
|
- RULE
|
|
- SEGMENT
|
|
- SERVICE_DESK_INTEGRATION
|
|
- SOD_POLICY
|
|
- SOURCE
|
|
- TAG
|
|
- TRANSFORM
|
|
- TRIGGER_SUBSCRIPTION
|
|
- WORKFLOW
|
|
example: TRIGGER_SUBSCRIPTION
|
|
objectOptions:
|
|
description: Additional options targeting specific objects related to each item in the includeTypes field.
|
|
type: object
|
|
additionalProperties:
|
|
type: object
|
|
properties:
|
|
includedNames:
|
|
description: Object names to be included in a backup.
|
|
type: array
|
|
items:
|
|
type: string
|
|
example: Test Object name
|
|
example:
|
|
TRIGGER_SUBSCRIPTION:
|
|
includedNames:
|
|
- Trigger Subscription name
|
|
hydrationStatus:
|
|
type: string
|
|
description: Whether the object details of this backup are ready.
|
|
enum:
|
|
- HYDRATED
|
|
- NOT_HYDRATED
|
|
example: NOT_HYDRATED
|
|
totalObjectCount:
|
|
type: integer
|
|
format: int64
|
|
description: Number of objects contained in this backup.
|
|
example: 10
|
|
cloudStorageStatus:
|
|
type: string
|
|
description: Whether this backup has been transferred to a customer storage location.
|
|
enum:
|
|
- SYNCED
|
|
- NOT_SYNCED
|
|
- SYNC_FAILED
|
|
example: SYNCED
|
|
example:
|
|
- jobId: 281d421c-0643-4004-9fe5-29a95d2f73df
|
|
status: COMPLETE
|
|
type: BACKUP
|
|
tenant: someTenant
|
|
requesterName: support
|
|
fileExists: true
|
|
created: '2024-03-07T21:11:00.375Z'
|
|
modified: '2024-03-07T21:11:25.046Z'
|
|
completed: '2024-03-07T21:11:00.66Z'
|
|
name: test1
|
|
userCanDelete: false
|
|
isPartial: false
|
|
backupType: UPLOADED
|
|
hydrationStatus: HYDRATED
|
|
totalObjectCount: 64
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Filters = "status eq "COMPLETE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional)
|
|
|
|
# List Uploaded Configurations
|
|
|
|
try {
|
|
Get-UploadedConfigurations
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-UploadedConfigurations -Filters $Filters
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UploadedConfigurations"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
post:
|
|
operationId: createUploadedConfiguration
|
|
security:
|
|
- userAuth:
|
|
- sp:config-backup:manage
|
|
tags:
|
|
- Configuration Hub
|
|
summary: Upload a Configuration
|
|
description: |-
|
|
This API uploads a JSON configuration file into a tenant.
|
|
|
|
Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality.
|
|
|
|
Refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects) for more information about supported objects.
|
|
requestBody:
|
|
description: |
|
|
The body will consist of "data" which should contain the json file and name wish should be the name you want to assign to the uploaded file"
|
|
|
|
__Example__
|
|
|
|
data: "uploaded.json",
|
|
name: "A_NEW_UPLOADED_BACKUP"
|
|
|
|
__Sample Upload File__
|
|
|
|
{
|
|
"version": 1,
|
|
"tenant": "a-sample-tenant",
|
|
"objects":
|
|
[
|
|
{
|
|
"version": 1,
|
|
"self":
|
|
{
|
|
"id": "0a59c7196d2917f8aa6d29686e6600fb",
|
|
"type": "SOURCE",
|
|
"name": "Extended Form"
|
|
},
|
|
"object":
|
|
{
|
|
"id": "0a59c7196d2917f8aa6d29686e6600fb",
|
|
"name": "Extended Form",
|
|
"type": "DelimitedFile",
|
|
"connectorClass": "sailpoint.connector.DelimitedFileConnector",
|
|
"connectorScriptName": "delimited-file-angularsc",
|
|
"description": "Migrated app - Extended Form (original ID: 0a59c7196d2917f8aa6d29686e6600fb)",
|
|
"deleteThreshold": 10,
|
|
"provisionAsCsv": false,
|
|
"owner":
|
|
{
|
|
"type": "IDENTITY",
|
|
"id": "0a59c7196d2917f8816d29685fed00c3",
|
|
"name": "slpt.services"
|
|
},
|
|
"connectorAttributes":
|
|
{
|
|
"beforemoveAccount": "Do Nothing",
|
|
"beforemoverAccount": "Do Nothing",
|
|
"busApp": "false",
|
|
"file": "Empty",
|
|
"filetransport": "local",
|
|
"filterEmptyRecords": "true",
|
|
"group.filetransport": "local",
|
|
"group.filterEmptyRecords": "true",
|
|
"group.partitionMode": "auto",
|
|
"hasHeader": "true",
|
|
"indexColumn": "ID",
|
|
"isCaseInsensitiveMerge": "false",
|
|
"isSortedByIndexColumn": "false",
|
|
"loaProcess": "Do Nothing",
|
|
"ltdProcess": "Do Nothing",
|
|
"mergeRows": "false",
|
|
"moverProcess": "Do Nothing",
|
|
"moverRevocation": "Do Nothing",
|
|
"nativeChangeDetectionAttributeScope": "entitlements",
|
|
"nativeChangeDetectionEnabled": "false",
|
|
"nativeChangeProcess": "Do Nothing",
|
|
"parseType": "delimited",
|
|
"partitionMode": "auto",
|
|
"policyType": "Do Nothing",
|
|
"rehireProcess": "Do Nothing",
|
|
"reverseleaverProcess": "Do Nothing",
|
|
"rtwloaProcess": "Do Nothing",
|
|
"rtwltdProcess": "Do Nothing",
|
|
"stopIfLineHasWrongColumnLength": "false",
|
|
"templateApplication": "DelimitedFile Template",
|
|
"terminationProcess": "Do Nothing"
|
|
},
|
|
"schemas":
|
|
[],
|
|
"provisioningPolicies":
|
|
[],
|
|
"features":
|
|
[
|
|
"DIRECT_PERMISSIONS",
|
|
"NO_RANDOM_ACCESS",
|
|
"DISCOVER_SCHEMA"
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
required: true
|
|
content:
|
|
multipart/form-data:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
data:
|
|
type: string
|
|
format: binary
|
|
description: JSON file containing the objects to be imported.
|
|
name:
|
|
type: string
|
|
description: Name that will be assigned to the uploaded configuration file.
|
|
required:
|
|
- data
|
|
- name
|
|
responses:
|
|
'202':
|
|
description: Upload job accepted and queued for processing.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1configuration-hub~1backups~1uploads/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/configuration-hub/BackupResponse.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Data = # System.IO.FileInfo | JSON file containing the objects to be imported.
|
|
$Name = "MyName" # String | Name that will be assigned to the uploaded configuration file.
|
|
|
|
# Upload a Configuration
|
|
|
|
try {
|
|
New-UploadedConfiguration-Data $Data -Name $Name
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# New-UploadedConfiguration -Data $Data -Name $Name
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-UploadedConfiguration"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/configuration-hub/backups/uploads/{id}:
|
|
get:
|
|
operationId: getUploadedConfiguration
|
|
security:
|
|
- userAuth:
|
|
- sp:config-backup:read
|
|
- sp:config-backup:manage
|
|
tags:
|
|
- Configuration Hub
|
|
summary: Get an Uploaded Configuration
|
|
description: This API gets an existing uploaded configuration for the current tenant.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
description: The id of the uploaded configuration.
|
|
example: 3d0fe04b-57df-4a46-a83b-8f04b0f9d10b
|
|
responses:
|
|
'200':
|
|
description: Gets an uploaded configuration details.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1configuration-hub~1backups~1uploads/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/configuration-hub/BackupResponse.yaml
|
|
example:
|
|
jobId: 2ea830f3-2b14-4772-8a20-3d006742e419
|
|
status: COMPLETE
|
|
type: BACKUP
|
|
tenant: someTenant
|
|
requesterName: support
|
|
fileExists: true
|
|
created: '2024-02-20T22:08:31.064Z'
|
|
modified: '2024-02-20T22:13:15.662Z'
|
|
completed: '2024-02-20T22:08:31.689Z'
|
|
name: something new
|
|
userCanDelete: false
|
|
isPartial: false
|
|
backupType: UPLOADED
|
|
hydrationStatus: HYDRATED
|
|
totalObjectCount: 2
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration.
|
|
|
|
# Get an Uploaded Configuration
|
|
|
|
try {
|
|
Get-UploadedConfiguration-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-UploadedConfiguration -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UploadedConfiguration"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
delete:
|
|
operationId: deleteUploadedConfiguration
|
|
security:
|
|
- userAuth:
|
|
- sp:config-backup:manage
|
|
tags:
|
|
- Configuration Hub
|
|
summary: Delete an Uploaded Configuration
|
|
description: |-
|
|
This API deletes an uploaded configuration based on Id.
|
|
|
|
On success, this endpoint will return an empty response.
|
|
|
|
The uploaded configuration id can be obtained from the response after a successful upload, or the list uploaded configurations endpoint.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
description: The id of the uploaded configuration.
|
|
example: 3d0fe04b-57df-4a46-a83b-8f04b0f9d10b
|
|
responses:
|
|
'204':
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/204.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration.
|
|
|
|
# Delete an Uploaded Configuration
|
|
|
|
try {
|
|
Remove-UploadedConfiguration-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Remove-UploadedConfiguration -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-UploadedConfiguration"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/connectors/{scriptName}:
|
|
get:
|
|
tags:
|
|
- Connectors
|
|
operationId: getConnector
|
|
summary: Get Connector by Script Name
|
|
description: 'Fetches a connector that using its script name. '
|
|
parameters:
|
|
- name: scriptName
|
|
in: path
|
|
description: The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getConnectorList
|
|
style: simple
|
|
explode: false
|
|
schema:
|
|
type: string
|
|
example: aScriptName
|
|
- in: query
|
|
name: locale
|
|
required: false
|
|
schema:
|
|
type: string
|
|
enum:
|
|
- de
|
|
- 'no'
|
|
- fi
|
|
- sv
|
|
- ru
|
|
- pt
|
|
- ko
|
|
- zh-TW
|
|
- en
|
|
- it
|
|
- fr
|
|
- zh-CN
|
|
- hu
|
|
- es
|
|
- cs
|
|
- ja
|
|
- pl
|
|
- da
|
|
- nl
|
|
example: de
|
|
description: The locale to apply to the config. If no viable locale is given, it will default to "en"
|
|
responses:
|
|
'200':
|
|
description: A Connector Dto object
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: The connector name
|
|
example: name
|
|
type:
|
|
type: string
|
|
description: The connector type
|
|
example: ServiceNow
|
|
className:
|
|
type: string
|
|
description: The connector class name
|
|
example: class name
|
|
scriptName:
|
|
type: string
|
|
description: The connector script name
|
|
example: servicenow
|
|
applicationXml:
|
|
type: string
|
|
description: The connector application xml
|
|
example: |
|
|
<?xml version='1.0' encoding='UTF-8'?>
|
|
<!DOCTYPE Application PUBLIC "sailpoint.dtd" "sailpoint.dtd">
|
|
<Application connector="sailpoint.connector.OpenConnectorAdapter" name="custom Atlassian Suite - Cloud" type="custom Atlassian Suite - Cloud"/>
|
|
correlationConfigXml:
|
|
type: string
|
|
description: The connector correlation config xml
|
|
example: "<?xml version='1.0' encoding='UTF-8'?>\n<!-- Copyright (C) 2021 SailPoint Technologies, Inc. All rights reserved. -->\n\n<!DOCTYPE CorrelationConfig PUBLIC \"sailpoint.dtd\" \"sailpoint.dtd\">\n\n<CorrelationConfig name=\"custom Atlassian Suite - Cloud Account Correlation Config\">\n\t<AttributeAssignments>\n\t\t<Filter operation=\"EQ\" property=\"email\" value=\"mail\"/>\n\t\t<Filter operation=\"EQ\" property=\"empId\" value=\"employeeNumber\"/>\n\t\t<Filter operation=\"EQ\" property=\"displayName\" value=\"cn\"/>\n\t</AttributeAssignments>\n</CorrelationConfig>\n"
|
|
sourceConfigXml:
|
|
type: string
|
|
description: The connector source config xml
|
|
example: |-
|
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?><!-- Copyright (C) 2023 SailPoint Technologies, Inc. All rights reserved. --><Form xmlns="http://www.sailpoint.com/xsd/sailpoint_form_2_0.xsd" connectorName="custom Atlassian Suite - Cloud" directConnect="true" fileUpload="true" name="Custom Atlassian Suite - Cloud" status="released" type="SourceConfig">
|
|
<BaseConfig>
|
|
<Field maxFiles="10" maxSize="300" name="fileUpload" supportedExtensions="jar" type="fileupload" validateJSON="false"/>
|
|
</BaseConfig>
|
|
|
|
|
|
|
|
</Form>
|
|
sourceConfig:
|
|
type: string
|
|
description: The connector source config
|
|
example: |-
|
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?><!-- Copyright (C) 2023 SailPoint Technologies, Inc. All rights reserved. --><Form xmlns="http://www.sailpoint.com/xsd/sailpoint_form_2_0.xsd" connectorName="custom Atlassian Suite - Cloud" directConnect="true" fileUpload="true" name="Custom Atlassian Suite - Cloud" status="released" type="SourceConfig">
|
|
<BaseConfig>
|
|
<Field maxFiles="10" maxSize="300" name="fileUpload" supportedExtensions="jar" type="fileupload" validateJSON="false"/>
|
|
</BaseConfig>
|
|
|
|
|
|
|
|
</Form>
|
|
sourceConfigFrom:
|
|
type: string
|
|
description: The connector source config origin
|
|
example: sp-connect
|
|
s3Location:
|
|
type: string
|
|
description: storage path key for this connector
|
|
example: custom-connector/scriptname
|
|
uploadedFiles:
|
|
type: array
|
|
description: The list of uploaded files supported by the connector. If there was any executable files uploaded to thee connector. Typically this be empty as the executable be uploaded at source creation.
|
|
nullable: true
|
|
items:
|
|
type: string
|
|
example:
|
|
- pod/org/connectorFiles/testconnector/test1.jar
|
|
fileUpload:
|
|
type: boolean
|
|
description: true if the source is file upload
|
|
example: true
|
|
default: false
|
|
directConnect:
|
|
type: boolean
|
|
description: true if the source is a direct connect source
|
|
example: true
|
|
default: false
|
|
translationProperties:
|
|
type: object
|
|
description: A map containing translation attributes by loacale key
|
|
additionalProperties: true
|
|
example:
|
|
de: |-
|
|
# Copyright (C) 2024 SailPoint Technologies, Inc. All rights reserved.
|
|
# DO NOT EDIT. This file is generated by "sailpointTranslate" command.
|
|
menuLabel_ConnectionSettings=Verbindungseinstellungen
|
|
menuLabel_AggregationSettings=Aggregationseinstellungen
|
|
sectionLabel_AuthenticationSettings=Verbindungseinstellungen
|
|
sectionLabel_AggregationSettings=Aggregationseinstellungen
|
|
sectionInfo_AuthenticationSettings=Konfigurieren Sie eine direkte Verbindung zwischen der Quelle Delinea Secret Server On-Premise und IdentityNow.<br><br>Geben Sie bei <strong>Zeit\u00fcberschreitung bei Verbindung</strong> die maximal erlaubte Zeitdauer (in Minuten) f\u00fcr die Verbindung von IdentityNow mit der Quelle ein.<br><br>Geben Sie die <strong>Host-URL</strong> der Delinea-SCIM-Serverquelle ein.<br><br>Geben Sie den <strong>API-Token</strong> der Quelle zur Authentifizierung ein.
|
|
sectionInfo_AggregationSettings=Geben Sie die Einstellungen f\u00fcr Ihre Aggregation an.<br><br>Geben Sie in das Feld <strong>Seitengr\u00f6\u00dfe</strong> die Anzahl an Kontoeintr\u00e4gen ein, die auf einer einzelnen Seite aggregiert werden sollen, wenn gro\u00dfe Datens\u00e4tze durchlaufen werden.<br>\n<br>Geben Sie im <strong>Kontofilter</strong> die Bedingungen f\u00fcr den Kontofilter an. Beispiel: userName sw "S"<br><br>Geben Sie im <strong>Gruppenfilter</strong> die Gruppenfilterbedingungen an. Beispiel: displayName sw "S".
|
|
placeHolder_accAggregation=userName sw "S"
|
|
placeHolder_grpAggregation=displayName sw "S"
|
|
placeHolder_host=https://{Delinea_SCIM_Server_host}/v2
|
|
docLinkLabel_AuthenticationSettings=Mehr \u00fcber Verbindungseinstellungen
|
|
docLinkLabel_Filters=Mehr \u00fcber Konto- und Gruppenfilter
|
|
HostURL=Host-URL
|
|
ConnectionTimeout=Zeit\u00fcberschreitung bei Verbindung
|
|
API_TOKEN=API-Token
|
|
JSONPathMapping=JSON-Path-Attribut-Mapping
|
|
FilterConditionForAccounts=Kontofilter
|
|
FilterConditionForGroups=Gruppenfilter
|
|
Page_Size=Seitengr\u00f6\u00dfe
|
|
SchemaAttribute=Schema-Attribut
|
|
JSONpath=JSON-Pfad
|
|
ShortDesc=Das Integrationsmodul IdentityNow f\u00fcr Delinea Secret Server On-Premise bietet die M\u00f6glichkeit einer tiefen Governance f\u00fcr Konten und Gruppen. Es unterst\u00fctzt au\u00dferdem das End-to-End-Lebenszyklus-Management.
|
|
connectorMetadata:
|
|
type: object
|
|
description: A map containing metadata pertinent to the UI to be used
|
|
additionalProperties: true
|
|
example:
|
|
supportedUI: EXTJS
|
|
platform: ccg
|
|
shortDesc: connector description
|
|
status:
|
|
type: string
|
|
enum:
|
|
- DEPRECATED
|
|
- DEVELOPMENT
|
|
- DEMO
|
|
- RELEASED
|
|
description: The connector status
|
|
example: RELEASED
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:connector-config:read
|
|
- idn:connector-config:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- SOURCE_ADMIN
|
|
- SOURCE_SUBADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
|
|
$Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional)
|
|
|
|
# Get Connector by Script Name
|
|
|
|
try {
|
|
Get-Connector-ScriptName $ScriptName
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-Connector -ScriptName $ScriptName -Locale $Locale
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Connector"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
delete:
|
|
tags:
|
|
- Connectors
|
|
operationId: deleteCustomConnector
|
|
summary: Delete Connector by Script Name
|
|
description: Delete a custom connector that using its script name.
|
|
parameters:
|
|
- name: scriptName
|
|
in: path
|
|
description: The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getConnectorList
|
|
style: simple
|
|
explode: false
|
|
schema:
|
|
type: string
|
|
example: aScriptName
|
|
responses:
|
|
'204':
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/204.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:connector-config:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- SOURCE_ADMIN
|
|
- SOURCE_SUBADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
|
|
|
|
# Delete Connector by Script Name
|
|
|
|
try {
|
|
Remove-CustomConnector-ScriptName $ScriptName
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Remove-CustomConnector -ScriptName $ScriptName
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-CustomConnector"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
patch:
|
|
tags:
|
|
- Connectors
|
|
operationId: updateConnector
|
|
summary: Update Connector by Script Name
|
|
description: |
|
|
This API updates a custom connector by script name using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
|
|
|
|
The following fields are patchable:
|
|
|
|
|
|
* connectorMetadata
|
|
|
|
* applicationXml
|
|
|
|
* correlationConfigXml
|
|
|
|
* sourceConfigXml
|
|
parameters:
|
|
- name: scriptName
|
|
in: path
|
|
description: The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getConnectorList
|
|
style: simple
|
|
explode: false
|
|
schema:
|
|
type: string
|
|
example: aScriptName
|
|
requestBody:
|
|
required: true
|
|
description: |
|
|
A list of connector detail update operations
|
|
content:
|
|
application/json-patch+json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/JsonPatchOperation.yaml
|
|
responses:
|
|
'200':
|
|
description: A updated Connector Dto object
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1connectors~1%7BscriptName%7D/get/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ConnectorDetail.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:connector-config:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- SOURCE_ADMIN
|
|
- SOURCE_SUBADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
|
|
# JsonPatchOperation[] | A list of connector detail update operations
|
|
$JsonPatchOperation = @"{
|
|
"op" : "replace",
|
|
"path" : "/description",
|
|
"value" : "New description"
|
|
}"@
|
|
|
|
|
|
# Update Connector by Script Name
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
|
|
Update-Connector-ScriptName $ScriptName -JsonPatchOperation $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Update-Connector -ScriptName $ScriptName -JsonPatchOperation $JsonPatchOperation
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Connector"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/connectors:
|
|
get:
|
|
tags:
|
|
- Connectors
|
|
operationId: getConnectorList
|
|
summary: Get Connector List
|
|
description: Fetches list of connectors that have 'RELEASED' status using filtering and pagination.
|
|
parameters:
|
|
- in: query
|
|
name: filters
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: |-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
**name**: *sw, co*
|
|
|
|
**type**: *sw, co, eq*
|
|
|
|
**directConnect**: *eq*
|
|
|
|
**category**: *eq*
|
|
|
|
**features**: *ca*
|
|
|
|
**labels**: *ca*
|
|
example: directConnect eq "true"
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
- in: query
|
|
name: locale
|
|
required: false
|
|
schema:
|
|
type: string
|
|
enum:
|
|
- de
|
|
- 'no'
|
|
- fi
|
|
- sv
|
|
- ru
|
|
- pt
|
|
- ko
|
|
- zh-TW
|
|
- en
|
|
- it
|
|
- fr
|
|
- zh-CN
|
|
- hu
|
|
- es
|
|
- cs
|
|
- ja
|
|
- pl
|
|
- da
|
|
- nl
|
|
example: de
|
|
description: The locale to apply to the config. If no viable locale is given, it will default to "en"
|
|
responses:
|
|
'200':
|
|
description: A Connector Dto object
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
title: custom connector response object
|
|
type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: The connector name
|
|
example: name
|
|
type:
|
|
type: string
|
|
description: The connector type
|
|
example: ServiceNow
|
|
scriptName:
|
|
type: string
|
|
description: The connector script name
|
|
example: servicenow
|
|
className:
|
|
type: string
|
|
nullable: true
|
|
description: The connector class name.
|
|
example: sailpoint.connector.OpenConnectorAdapter
|
|
features:
|
|
type: array
|
|
description: The list of features supported by the connector
|
|
nullable: true
|
|
items:
|
|
type: string
|
|
example:
|
|
- PROVISIONING
|
|
- SYNC_PROVISIONING
|
|
- SEARCH
|
|
- UNSTRUCTURED_TARGETS
|
|
directConnect:
|
|
type: boolean
|
|
description: true if the source is a direct connect source
|
|
example: true
|
|
default: false
|
|
connectorMetadata:
|
|
type: object
|
|
additionalProperties: true
|
|
description: A map containing metadata pertinent to the connector
|
|
example:
|
|
supportedUI: ANGULAR
|
|
platform: ccg
|
|
shortDesc: connector description
|
|
status:
|
|
type: string
|
|
enum:
|
|
- DEPRECATED
|
|
- DEVELOPMENT
|
|
- DEMO
|
|
- RELEASED
|
|
description: The connector status
|
|
example: RELEASED
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:connector-config:read
|
|
- idn:connector-config:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- SOURCE_ADMIN
|
|
- SOURCE_SUBADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Filters = "directConnect eq "true"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* (optional)
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
$Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional)
|
|
|
|
# Get Connector List
|
|
|
|
try {
|
|
Get-ConnectorList
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-ConnectorList -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count -Locale $Locale
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ConnectorList"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
post:
|
|
tags:
|
|
- Connectors
|
|
operationId: createCustomConnector
|
|
summary: Create Custom Connector
|
|
description: 'Create custom connector. '
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
title: custom connector create request
|
|
type: object
|
|
required:
|
|
- name
|
|
- className
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: The connector name. Need to be unique per tenant. The name will able be used to derive a url friendly unique scriptname that will be in response. Script name can then be used for all update endpoints
|
|
example: custom connector
|
|
type:
|
|
type: string
|
|
description: The connector type. If not specified will be defaulted to 'custom '+name
|
|
example: custom connector type
|
|
className:
|
|
type: string
|
|
description: The connector class name. If you are implementing openconnector standard (what is recommended), then this need to be set to sailpoint.connector.OpenConnectorAdapter
|
|
example: sailpoint.connector.OpenConnectorAdapter
|
|
directConnect:
|
|
type: boolean
|
|
description: true if the source is a direct connect source
|
|
default: true
|
|
example: true
|
|
status:
|
|
type: string
|
|
enum:
|
|
- DEVELOPMENT
|
|
- DEMO
|
|
- RELEASED
|
|
description: The connector status
|
|
example: RELEASED
|
|
responses:
|
|
'200':
|
|
description: A Connector Dto object
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1connectors/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/V3ConnectorDto.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:connector-config:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- SOURCE_ADMIN
|
|
- SOURCE_SUBADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$V3CreateConnectorDto = @"
|
|
{
|
|
"name" : "custom connector",
|
|
"directConnect" : true,
|
|
"className" : "sailpoint.connector.OpenConnectorAdapter",
|
|
"type" : "custom connector type",
|
|
"status" : "RELEASED"
|
|
}
|
|
"@
|
|
|
|
# Create Custom Connector
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToV3CreateConnectorDto -Json $V3CreateConnectorDto
|
|
New-CustomConnector-V3CreateConnectorDto $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# New-CustomConnector -V3CreateConnectorDto $V3CreateConnectorDto
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-CustomConnector"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/connectors/{scriptName}/source-config:
|
|
get:
|
|
tags:
|
|
- Connectors
|
|
operationId: getConnectorSourceConfig
|
|
summary: Get Connector Source Configuration
|
|
description: 'Fetches a connector''s source config using its script name. '
|
|
parameters:
|
|
- name: scriptName
|
|
in: path
|
|
description: The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getConnectorList
|
|
style: simple
|
|
explode: false
|
|
schema:
|
|
type: string
|
|
example: aScriptName
|
|
responses:
|
|
'200':
|
|
description: The connector's source template
|
|
content:
|
|
application/xml:
|
|
schema:
|
|
type: string
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:connector-config:read
|
|
- idn:connector-config:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- SOURCE_ADMIN
|
|
- SOURCE_SUBADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
|
|
|
|
# Get Connector Source Configuration
|
|
|
|
try {
|
|
Get-ConnectorSourceConfig-ScriptName $ScriptName
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-ConnectorSourceConfig -ScriptName $ScriptName
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ConnectorSourceConfig"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
put:
|
|
tags:
|
|
- Connectors
|
|
operationId: putConnectorSourceConfig
|
|
summary: Update Connector Source Configuration
|
|
description: 'Update a connector''s source config using its script name. '
|
|
parameters:
|
|
- name: scriptName
|
|
in: path
|
|
description: The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getConnectorList
|
|
style: simple
|
|
explode: false
|
|
schema:
|
|
type: string
|
|
example: aScriptName
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
multipart/form-data:
|
|
schema:
|
|
type: object
|
|
required:
|
|
- file
|
|
properties:
|
|
file:
|
|
type: string
|
|
description: connector source config xml file
|
|
format: binary
|
|
responses:
|
|
'200':
|
|
description: The connector's update detail
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
message:
|
|
type: string
|
|
description: The detailed message for an update. Typically the relevent error message when status is error.
|
|
example: unsupported xsd version, please ensure latest xsd version http://www.sailpoint.com/xsd/sailpoint_form_2_0.xsd is used for source config
|
|
scriptName:
|
|
type: string
|
|
description: The connector script name
|
|
example: servicenow
|
|
updatedFiles:
|
|
type: array
|
|
description: The list of updated files supported by the connector
|
|
nullable: true
|
|
items:
|
|
type: string
|
|
example:
|
|
- pod/org/connectorFiles/testconnector/test1.jar
|
|
status:
|
|
type: string
|
|
enum:
|
|
- ERROR
|
|
- UPDATED
|
|
- UNCHANGED
|
|
- SKIPPED
|
|
description: The connector update status
|
|
example: ERROR
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:connector-config:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- SOURCE_ADMIN
|
|
- SOURCE_SUBADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
|
|
$File = # System.IO.FileInfo | connector source config xml file
|
|
|
|
# Update Connector Source Configuration
|
|
|
|
try {
|
|
Send-ConnectorSourceConfig-ScriptName $ScriptName -File $File
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Send-ConnectorSourceConfig -ScriptName $ScriptName -File $File
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ConnectorSourceConfig"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/connectors/{scriptName}/translations/{locale}:
|
|
get:
|
|
tags:
|
|
- Connectors
|
|
operationId: getConnectorTranslations
|
|
summary: Get Connector Translations
|
|
description: 'Fetches a connector''s translations using its script name. '
|
|
parameters:
|
|
- name: scriptName
|
|
in: path
|
|
description: The scriptName value of the connector. Scriptname is the unique id generated at connector creation.
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getConnectorList
|
|
style: simple
|
|
explode: false
|
|
schema:
|
|
type: string
|
|
example: aScriptName
|
|
- name: locale
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
enum:
|
|
- de
|
|
- 'no'
|
|
- fi
|
|
- sv
|
|
- ru
|
|
- pt
|
|
- ko
|
|
- zh-TW
|
|
- en
|
|
- it
|
|
- fr
|
|
- zh-CN
|
|
- hu
|
|
- es
|
|
- cs
|
|
- ja
|
|
- pl
|
|
- da
|
|
- nl
|
|
example: de
|
|
description: The locale to apply to the config. If no viable locale is given, it will default to "en"
|
|
responses:
|
|
'200':
|
|
description: The connector's translations
|
|
content:
|
|
text/plain:
|
|
schema:
|
|
type: string
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:connector-config:read
|
|
- idn:connector-config:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- SOURCE_ADMIN
|
|
- SOURCE_SUBADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation.
|
|
$Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en""
|
|
|
|
# Get Connector Translations
|
|
|
|
try {
|
|
Get-ConnectorTranslations-ScriptName $ScriptName -Locale $Locale
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-ConnectorTranslations -ScriptName $ScriptName -Locale $Locale
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ConnectorTranslations"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
put:
|
|
tags:
|
|
- Connectors
|
|
operationId: putConnectorTranslations
|
|
summary: Update Connector Translations
|
|
description: 'Update a connector''s translations using its script name. '
|
|
parameters:
|
|
- name: scriptName
|
|
in: path
|
|
description: The scriptName value of the connector. Scriptname is the unique id generated at connector creation.
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getConnectorList
|
|
style: simple
|
|
explode: false
|
|
schema:
|
|
type: string
|
|
example: aScriptName
|
|
- name: locale
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
enum:
|
|
- de
|
|
- 'no'
|
|
- fi
|
|
- sv
|
|
- ru
|
|
- pt
|
|
- ko
|
|
- zh-TW
|
|
- en
|
|
- it
|
|
- fr
|
|
- zh-CN
|
|
- hu
|
|
- es
|
|
- cs
|
|
- ja
|
|
- pl
|
|
- da
|
|
- nl
|
|
example: de
|
|
description: The locale to apply to the config. If no viable locale is given, it will default to "en"
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
multipart/form-data:
|
|
schema:
|
|
type: object
|
|
responses:
|
|
'200':
|
|
description: The connector's update detail
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1connectors~1%7BscriptName%7D~1source-config/put/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/UpdateDetail.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:connector-config:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- SOURCE_ADMIN
|
|
- SOURCE_SUBADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation.
|
|
$Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en""
|
|
|
|
# Update Connector Translations
|
|
|
|
try {
|
|
Send-ConnectorTranslations-ScriptName $ScriptName -Locale $Locale
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Send-ConnectorTranslations -ScriptName $ScriptName -Locale $Locale
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ConnectorTranslations"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/connectors/{scriptName}/source-template:
|
|
get:
|
|
tags:
|
|
- Connectors
|
|
operationId: getConnectorSourceTemplate
|
|
summary: Get Connector Source Template
|
|
description: 'Fetches a connector''s source template using its script name. '
|
|
parameters:
|
|
- name: scriptName
|
|
in: path
|
|
description: The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getConnectorList
|
|
style: simple
|
|
explode: false
|
|
schema:
|
|
type: string
|
|
example: aScriptName
|
|
responses:
|
|
'200':
|
|
description: The connector's source template
|
|
content:
|
|
application/xml:
|
|
schema:
|
|
type: string
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:connector-config:read
|
|
- idn:connector-config:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- SOURCE_ADMIN
|
|
- SOURCE_SUBADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
|
|
|
|
# Get Connector Source Template
|
|
|
|
try {
|
|
Get-ConnectorSourceTemplate-ScriptName $ScriptName
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-ConnectorSourceTemplate -ScriptName $ScriptName
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ConnectorSourceTemplate"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
put:
|
|
tags:
|
|
- Connectors
|
|
operationId: putConnectorSourceTemplate
|
|
summary: Update Connector Source Template
|
|
description: 'Update a connector''s source template using its script name. '
|
|
parameters:
|
|
- name: scriptName
|
|
in: path
|
|
description: The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getConnectorList
|
|
style: simple
|
|
explode: false
|
|
schema:
|
|
type: string
|
|
example: aScriptName
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
multipart/form-data:
|
|
schema:
|
|
type: object
|
|
required:
|
|
- file
|
|
properties:
|
|
file:
|
|
type: string
|
|
description: connector source template xml file
|
|
format: binary
|
|
responses:
|
|
'200':
|
|
description: The connector's update detail
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1connectors~1%7BscriptName%7D~1source-config/put/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/UpdateDetail.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:connector-config:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- SOURCE_ADMIN
|
|
- SOURCE_SUBADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
|
|
$File = # System.IO.FileInfo | connector source template xml file
|
|
|
|
# Update Connector Source Template
|
|
|
|
try {
|
|
Send-ConnectorSourceTemplate-ScriptName $ScriptName -File $File
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Send-ConnectorSourceTemplate -ScriptName $ScriptName -File $File
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ConnectorSourceTemplate"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/identities/{identity-id}/set-lifecycle-state:
|
|
post:
|
|
operationId: setLifecycleState
|
|
tags:
|
|
- Lifecycle States
|
|
summary: Set Lifecycle State
|
|
description: Use this API to set/update an identity's lifecycle state to the one provided and update the corresponding identity profile.
|
|
security:
|
|
- userAuth:
|
|
- idn:identity-lifecycle-state:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
parameters:
|
|
- in: path
|
|
name: identity-id
|
|
description: ID of the identity to update.
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listIdentities
|
|
example: 2c9180857893f1290178944561990364
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
lifecycleStateId:
|
|
type: string
|
|
description: ID of the lifecycle state to set.
|
|
example: 2c9180877a86e408017a8c19fefe046c
|
|
responses:
|
|
'200':
|
|
description: The request was successfully accepted into the system.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
accountActivityId:
|
|
type: string
|
|
example: 2c9180837ab5b716017ab7c6c9ef1e20
|
|
description: ID of the IdentityRequest object that is generated when the workflow launches. To follow the IdentityRequest, you can provide this ID with a [Get Account Activity request](https://developer.sailpoint.com/docs/api/v3/get-account-activity/). The response will contain relevant information about the IdentityRequest, such as its status.
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$IdentityId = "2c9180857893f1290178944561990364" # String | ID of the identity to update.
|
|
$SetLifecycleStateRequest = @"
|
|
|
|
"@
|
|
|
|
# Set Lifecycle State
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToSetLifecycleStateRequest -Json $SetLifecycleStateRequest
|
|
Set-LifecycleState-IdentityId $IdentityId -SetLifecycleStateRequest $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Set-LifecycleState -IdentityId $IdentityId -SetLifecycleStateRequest $SetLifecycleStateRequest
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-LifecycleState"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/identity-profiles/{identity-profile-id}/lifecycle-states:
|
|
get:
|
|
operationId: getLifecycleStates
|
|
tags:
|
|
- Lifecycle States
|
|
summary: Lists LifecycleStates
|
|
description: 'Use this endpoint to list all lifecycle states by their associated identity profiles. '
|
|
security:
|
|
- userAuth:
|
|
- idn:identity-profile-lifecycle-state:read
|
|
- applicationAuth:
|
|
- idn:identity-profile-lifecycle-state:read
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
parameters:
|
|
- in: path
|
|
name: identity-profile-id
|
|
description: Identity profile ID.
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listIdentityProfiles
|
|
schema:
|
|
type: string
|
|
example: 2b838de9-db9b-abcf-e646-d4f274ad4238
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
- in: query
|
|
name: sorters
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: comma-separated
|
|
example: created,modified
|
|
description: |-
|
|
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
|
|
|
Sorting is supported for the following fields: **created, modified**
|
|
responses:
|
|
'200':
|
|
description: List of LifecycleState objects.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
allOf:
|
|
- $ref: '#/components/schemas/Account/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/BaseCommonDto.yaml
|
|
- type: object
|
|
required:
|
|
- technicalName
|
|
properties:
|
|
enabled:
|
|
type: boolean
|
|
default: false
|
|
example: true
|
|
description: Indicates whether the lifecycle state is enabled or disabled.
|
|
technicalName:
|
|
type: string
|
|
example: Technical Name
|
|
description: The lifecycle state's technical name. This is for internal use.
|
|
description:
|
|
type: string
|
|
example: Lifecycle description
|
|
description: Lifecycle state's description.
|
|
identityCount:
|
|
type: integer
|
|
format: int32
|
|
example: 42
|
|
readOnly: true
|
|
description: Number of identities that have the lifecycle state.
|
|
emailNotificationOption:
|
|
type: object
|
|
description: This is used for representing email configuration for a lifecycle state
|
|
properties:
|
|
notifyManagers:
|
|
type: boolean
|
|
default: false
|
|
example: true
|
|
description: If true, then the manager is notified of the lifecycle state change.
|
|
notifyAllAdmins:
|
|
type: boolean
|
|
default: false
|
|
example: true
|
|
description: If true, then all the admins are notified of the lifecycle state change.
|
|
notifySpecificUsers:
|
|
type: boolean
|
|
default: false
|
|
example: true
|
|
description: If true, then the users specified in "emailAddressList" below are notified of lifecycle state change.
|
|
emailAddressList:
|
|
type: array
|
|
example:
|
|
- test@test.com
|
|
- test2@test.com
|
|
items:
|
|
type: string
|
|
description: List of user email addresses. If "notifySpecificUsers" option is true, then these users are notified of lifecycle state change.
|
|
accountActions:
|
|
type: array
|
|
items:
|
|
type: object
|
|
description: Object for specifying Actions to be performed on a specified list of sources' account.
|
|
properties:
|
|
action:
|
|
example: ENABLE
|
|
type: string
|
|
description: Describes if action will be enabled or disabled
|
|
enum:
|
|
- ENABLE
|
|
- DISABLE
|
|
sourceIds:
|
|
type: array
|
|
items:
|
|
type: string
|
|
uniqueItems: true
|
|
example:
|
|
- 2c918084660f45d6016617daa9210584
|
|
- 2c918084660f45d6016617daa9210500
|
|
description: List of unique source IDs. The sources must have the ENABLE feature or flat file source. See "/sources" endpoint for source features.
|
|
accessProfileIds:
|
|
type: array
|
|
items:
|
|
type: string
|
|
uniqueItems: true
|
|
example:
|
|
- 2c918084660f45d6016617daa9210584
|
|
- 2c918084660f45d6016617daa9210500
|
|
description: List of unique access-profile IDs that are associated with the lifecycle state.
|
|
identityState:
|
|
type: string
|
|
nullable: true
|
|
example: null
|
|
description: The lifecycle state's associated identity state. This field is generally 'null'.
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID.
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
$Sorters = "created,modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional)
|
|
|
|
# Lists LifecycleStates
|
|
|
|
try {
|
|
Get-LifecycleStates-IdentityProfileId $IdentityProfileId
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-LifecycleStates -IdentityProfileId $IdentityProfileId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-LifecycleStates"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
post:
|
|
operationId: createLifecycleState
|
|
tags:
|
|
- Lifecycle States
|
|
summary: Create Lifecycle State
|
|
description: Use this endpoint to create a lifecycle state.
|
|
security:
|
|
- userAuth:
|
|
- idn:identity-profile-lifecycle-state:manage
|
|
- applicationAuth:
|
|
- idn:identity-profile-lifecycle-state:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
parameters:
|
|
- in: path
|
|
name: identity-profile-id
|
|
description: Identity profile ID.
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listIdentityProfiles
|
|
schema:
|
|
type: string
|
|
example: 2b838de9-db9b-abcf-e646-d4f274ad4238
|
|
requestBody:
|
|
description: Lifecycle state to be created.
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1identity-profiles~1%7Bidentity-profile-id%7D~1lifecycle-states/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/LifecycleState.yaml
|
|
responses:
|
|
'201':
|
|
description: Created LifecycleState object.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1identity-profiles~1%7Bidentity-profile-id%7D~1lifecycle-states/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/LifecycleState.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID.
|
|
$LifecycleState = @"
|
|
{
|
|
"accessProfileIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ],
|
|
"emailNotificationOption" : {
|
|
"notifyManagers" : true,
|
|
"notifySpecificUsers" : true,
|
|
"emailAddressList" : [ "test@test.com", "test2@test.com" ],
|
|
"notifyAllAdmins" : true
|
|
},
|
|
"created" : "2015-05-28T14:07:17Z",
|
|
"name" : "aName",
|
|
"modified" : "2015-05-28T14:07:17Z",
|
|
"description" : "Lifecycle description",
|
|
"accountActions" : [ {
|
|
"action" : "ENABLE",
|
|
"sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ]
|
|
}, {
|
|
"action" : "ENABLE",
|
|
"sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ]
|
|
} ],
|
|
"id" : "id12345",
|
|
"identityCount" : 42,
|
|
"technicalName" : "Technical Name",
|
|
"identityState" : "identityState",
|
|
"enabled" : true
|
|
}
|
|
"@
|
|
|
|
# Create Lifecycle State
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToLifecycleState -Json $LifecycleState
|
|
New-LifecycleState-IdentityProfileId $IdentityProfileId -LifecycleState $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# New-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleState $LifecycleState
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-LifecycleState"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}:
|
|
get:
|
|
operationId: getLifecycleState
|
|
tags:
|
|
- Lifecycle States
|
|
summary: Get Lifecycle State
|
|
description: 'Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. '
|
|
security:
|
|
- userAuth:
|
|
- idn:identity-profile-lifecycle-state:read
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
parameters:
|
|
- in: path
|
|
name: identity-profile-id
|
|
description: Identity profile ID.
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listIdentityProfiles
|
|
schema:
|
|
type: string
|
|
example: 2b838de9-db9b-abcf-e646-d4f274ad4238
|
|
- in: path
|
|
name: lifecycle-state-id
|
|
description: Lifecycle state ID.
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getLifecycleStates
|
|
schema:
|
|
type: string
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
responses:
|
|
'200':
|
|
description: The requested LifecycleState was successfully retrieved.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1identity-profiles~1%7Bidentity-profile-id%7D~1lifecycle-states/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/LifecycleState.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID.
|
|
$LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID.
|
|
|
|
# Get Lifecycle State
|
|
|
|
try {
|
|
Get-LifecycleState-IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-LifecycleState"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
patch:
|
|
operationId: updateLifecycleStates
|
|
tags:
|
|
- Lifecycle States
|
|
summary: Update Lifecycle State
|
|
description: Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
security:
|
|
- userAuth:
|
|
- idn:identity-profile-lifecycle-state:manage
|
|
- applicationAuth:
|
|
- idn:identity-profile-lifecycle-state:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
parameters:
|
|
- in: path
|
|
name: identity-profile-id
|
|
description: Identity profile ID.
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listIdentityProfiles
|
|
schema:
|
|
type: string
|
|
example: 2b838de9-db9b-abcf-e646-d4f274ad4238
|
|
- in: path
|
|
name: lifecycle-state-id
|
|
description: Lifecycle state ID.
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getLifecycleStates
|
|
schema:
|
|
type: string
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
requestBody:
|
|
required: true
|
|
description: |
|
|
A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
|
|
The following fields can be updated:
|
|
* enabled
|
|
* description
|
|
* accountActions
|
|
* accessProfileIds
|
|
* emailNotificationOption
|
|
content:
|
|
application/json-patch+json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/JsonPatchOperation.yaml
|
|
example:
|
|
- op: replace
|
|
path: /description
|
|
value: Updated description!
|
|
- op: replace
|
|
path: /accessProfileIds
|
|
value:
|
|
- 2c918087742bab150174407a80f3125e
|
|
- 2c918087742bab150174407a80f3124f
|
|
- op: replace
|
|
path: /accountActions
|
|
value:
|
|
- action: ENABLE
|
|
sourceIds:
|
|
- 2c9180846a2f82fb016a481c1b1560c5
|
|
- 2c9180846a2f82fb016a481c1b1560cc
|
|
- action: DISABLE
|
|
sourceIds:
|
|
- 2c91808869a0c9980169a207258513fb
|
|
- op: replace
|
|
path: /emailNotificationOption
|
|
value:
|
|
notifyManagers: true
|
|
notifyAllAdmins: false
|
|
notifySpecificUsers: false
|
|
emailAddressList: []
|
|
responses:
|
|
'200':
|
|
description: The LifecycleState was successfully updated.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1identity-profiles~1%7Bidentity-profile-id%7D~1lifecycle-states/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/LifecycleState.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID.
|
|
$LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID.
|
|
# JsonPatchOperation[] | A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption
|
|
$JsonPatchOperation = @"{
|
|
"op" : "replace",
|
|
"path" : "/description",
|
|
"value" : "New description"
|
|
}"@
|
|
|
|
|
|
# Update Lifecycle State
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
|
|
Update-LifecycleStates-IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Update-LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $JsonPatchOperation
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-LifecycleStates"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
delete:
|
|
operationId: deleteLifecycleState
|
|
tags:
|
|
- Lifecycle States
|
|
summary: Delete Lifecycle State
|
|
description: 'Use this endpoint to delete the lifecycle state by its ID. '
|
|
security:
|
|
- userAuth:
|
|
- idn:identity-profile-lifecycle-state:manage
|
|
- applicationAuth:
|
|
- idn:identity-profile-lifecycle-state:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
parameters:
|
|
- in: path
|
|
name: identity-profile-id
|
|
description: Identity profile ID.
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listIdentityProfiles
|
|
schema:
|
|
type: string
|
|
example: 2b838de9-db9b-abcf-e646-d4f274ad4238
|
|
- in: path
|
|
name: lifecycle-state-id
|
|
description: Lifecycle state ID.
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getLifecycleStates
|
|
schema:
|
|
type: string
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
responses:
|
|
'202':
|
|
description: The request was successfully accepted into the system.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
description: Deleted lifecycle state.
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: Deleted lifecycle state's DTO type.
|
|
enum:
|
|
- LIFECYCLE_STATE
|
|
example: LIFECYCLE_STATE
|
|
id:
|
|
type: string
|
|
description: Deleted lifecycle state ID.
|
|
example: 12345
|
|
name:
|
|
type: string
|
|
description: Deleted lifecycle state's display name.
|
|
example: Contractor Lifecycle
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID.
|
|
$LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID.
|
|
|
|
# Delete Lifecycle State
|
|
|
|
try {
|
|
Remove-LifecycleState-IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Remove-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-LifecycleState"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/identity-profiles:
|
|
get:
|
|
operationId: listIdentityProfiles
|
|
tags:
|
|
- Identity Profiles
|
|
summary: Identity Profiles List
|
|
description: This returns a list of Identity Profiles based on the specified query parameters.
|
|
parameters:
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
- in: query
|
|
name: filters
|
|
required: false
|
|
schema:
|
|
type: string
|
|
example: id eq "ef38f94347e94562b5bb8424a56397d8"
|
|
description: |-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
**id**: *eq, ne, ge, gt, in, le, lt, isnull, sw*
|
|
|
|
**name**: *eq, ne, ge, gt, in, le, lt, isnull, sw*
|
|
|
|
**priority**: *eq, ne*
|
|
- in: query
|
|
name: sorters
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: comma-separated
|
|
example: id,name
|
|
description: |-
|
|
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
|
|
|
Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name**
|
|
responses:
|
|
'200':
|
|
description: List of identityProfiles.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
allOf:
|
|
- $ref: '#/components/schemas/Account/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/BaseCommonDto.yaml
|
|
- type: object
|
|
required:
|
|
- authoritativeSource
|
|
properties:
|
|
description:
|
|
type: string
|
|
description: The description of the Identity Profile.
|
|
example: My custom flat file profile
|
|
nullable: true
|
|
owner:
|
|
type: object
|
|
description: The owner of the Identity Profile.
|
|
nullable: true
|
|
properties:
|
|
type:
|
|
type: string
|
|
enum:
|
|
- IDENTITY
|
|
description: Type of the object to which this reference applies
|
|
example: IDENTITY
|
|
id:
|
|
type: string
|
|
description: ID of the object to which this reference applies
|
|
example: 2c9180835d191a86015d28455b4b232a
|
|
name:
|
|
type: string
|
|
description: Human-readable display name of the object to which this reference applies
|
|
example: William Wilson
|
|
priority:
|
|
type: integer
|
|
format: int64
|
|
description: The priority for an Identity Profile.
|
|
example: 10
|
|
authoritativeSource:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
enum:
|
|
- SOURCE
|
|
description: Type of the object to which this reference applies
|
|
example: SOURCE
|
|
id:
|
|
type: string
|
|
description: ID of the object to which this reference applies
|
|
example: 2c9180835d191a86015d28455b4b232a
|
|
name:
|
|
type: string
|
|
description: Human-readable display name of the object to which this reference applies
|
|
example: HR Active Directory
|
|
identityRefreshRequired:
|
|
type: boolean
|
|
default: false
|
|
description: True if a identity refresh is needed. Typically triggered when a change on the source has been made.
|
|
example: true
|
|
identityCount:
|
|
type: integer
|
|
description: The number of identities that belong to the Identity Profile.
|
|
format: int32
|
|
example: 8
|
|
identityAttributeConfig:
|
|
$ref: '#/components/schemas/IdentityProfile/allOf/1/properties/identityAttributeConfig'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/IdentityAttributeConfig.yaml
|
|
identityExceptionReportReference:
|
|
$ref: '#/components/schemas/IdentityProfile/allOf/1/properties/identityExceptionReportReference'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/IdentityExceptionReportReference.yaml
|
|
hasTimeBasedAttr:
|
|
description: Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile.
|
|
type: boolean
|
|
default: false
|
|
example: true
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:identity-profile:read
|
|
- applicationAuth:
|
|
- idn:identity-profile:read
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
$Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **priority**: *eq, ne* (optional)
|
|
$Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional)
|
|
|
|
# Identity Profiles List
|
|
|
|
try {
|
|
Get-IdentityProfiles
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-IdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityProfiles"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
post:
|
|
operationId: createIdentityProfile
|
|
summary: Create an Identity Profile
|
|
description: 'This creates an Identity Profile. '
|
|
tags:
|
|
- Identity Profiles
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1identity-profiles/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/IdentityProfile.yaml
|
|
responses:
|
|
'201':
|
|
description: The created Identity Profile
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1identity-profiles/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/IdentityProfile.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:identity-profile:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$IdentityProfile = @"
|
|
{
|
|
"owner" : {
|
|
"name" : "William Wilson",
|
|
"id" : "2c9180835d191a86015d28455b4b232a",
|
|
"type" : "IDENTITY"
|
|
},
|
|
"identityExceptionReportReference" : {
|
|
"reportName" : "My annual report",
|
|
"taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238"
|
|
},
|
|
"authoritativeSource" : {
|
|
"name" : "HR Active Directory",
|
|
"id" : "2c9180835d191a86015d28455b4b232a",
|
|
"type" : "SOURCE"
|
|
},
|
|
"hasTimeBasedAttr" : true,
|
|
"created" : "2015-05-28T14:07:17Z",
|
|
"description" : "My custom flat file profile",
|
|
"identityRefreshRequired" : true,
|
|
"identityCount" : 8,
|
|
"priority" : 10,
|
|
"identityAttributeConfig" : {
|
|
"attributeTransforms" : [ {
|
|
"transformDefinition" : {
|
|
"attributes" : {
|
|
"attributeName" : "e-mail",
|
|
"sourceName" : "MySource",
|
|
"sourceId" : "2c9180877a826e68017a8c0b03da1a53"
|
|
},
|
|
"type" : "accountAttribute"
|
|
},
|
|
"identityAttributeName" : "email"
|
|
}, {
|
|
"transformDefinition" : {
|
|
"attributes" : {
|
|
"attributeName" : "e-mail",
|
|
"sourceName" : "MySource",
|
|
"sourceId" : "2c9180877a826e68017a8c0b03da1a53"
|
|
},
|
|
"type" : "accountAttribute"
|
|
},
|
|
"identityAttributeName" : "email"
|
|
} ],
|
|
"enabled" : true
|
|
},
|
|
"name" : "aName",
|
|
"modified" : "2015-05-28T14:07:17Z",
|
|
"id" : "id12345"
|
|
}
|
|
"@
|
|
|
|
# Create an Identity Profile
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile
|
|
New-IdentityProfile-IdentityProfile $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# New-IdentityProfile -IdentityProfile $IdentityProfile
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-IdentityProfile"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/identity-profiles/bulk-delete:
|
|
post:
|
|
operationId: deleteIdentityProfiles
|
|
tags:
|
|
- Identity Profiles
|
|
summary: Delete Identity Profiles
|
|
description: |-
|
|
This deletes multiple Identity Profiles via a list of supplied IDs.
|
|
|
|
On success, this endpoint will return a reference to the bulk delete task result.
|
|
|
|
The following rights are required to access this endpoint: idn:identity-profile:delete
|
|
requestBody:
|
|
description: Identity Profile bulk delete request body.
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
description: List of Identity Profile IDs to delete.
|
|
type: array
|
|
items:
|
|
type: string
|
|
example:
|
|
- 2c9180867b2a34e0017b3078d60b0699
|
|
- 2c9180867b2a34e0017b3078d60b0698
|
|
responses:
|
|
'202':
|
|
description: Accepted - Returns a TaskResult object referencing the bulk delete job created.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: Task identifier
|
|
example: ff8081814d977c21014da056804a0af3
|
|
name:
|
|
type: string
|
|
description: Task name
|
|
example: Background Object Terminator c8f030f2-b1a6-4e33-99e8-6935bc18735d
|
|
description:
|
|
type: string
|
|
description: Task description
|
|
example: Generic task for terminating data in the overlay, used by the TerminationService.
|
|
launcher:
|
|
type: string
|
|
description: User or process who launched the task
|
|
example: support
|
|
completed:
|
|
type: string
|
|
format: date-time
|
|
description: Date time of completion
|
|
example: Mon Aug 21 14:57:39 CDT 2023
|
|
launched:
|
|
type: string
|
|
format: date-time
|
|
description: Date time when the task was launched
|
|
example: Mon Aug 21 14:55:39 CDT 2023
|
|
completionStatus:
|
|
type: string
|
|
enum:
|
|
- Success
|
|
- Warning
|
|
- Error
|
|
- Terminated
|
|
- TempError
|
|
description: Task result status
|
|
example: Success
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:identity-profile:delete
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$RequestBody = "MyRequestBody" # String[] | Identity Profile bulk delete request body.
|
|
$RequestBody = @""@
|
|
|
|
|
|
# Delete Identity Profiles
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
|
|
Remove-IdentityProfiles-RequestBody $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Remove-IdentityProfiles -RequestBody $RequestBody
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-IdentityProfiles"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/identity-profiles/export:
|
|
get:
|
|
operationId: exportIdentityProfiles
|
|
tags:
|
|
- Identity Profiles
|
|
summary: Export Identity Profiles
|
|
description: This exports existing identity profiles in the format specified by the sp-config service.
|
|
parameters:
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
- in: query
|
|
name: filters
|
|
required: false
|
|
schema:
|
|
type: string
|
|
example: id eq "ef38f94347e94562b5bb8424a56397d8"
|
|
description: |-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
**id**: *eq, ne*
|
|
|
|
**name**: *eq, ne*
|
|
|
|
**priority**: *eq, ne*
|
|
- in: query
|
|
name: sorters
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: comma-separated
|
|
example: id,name
|
|
description: |-
|
|
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
|
|
|
Sorting is supported for the following fields: **id, name, priority**
|
|
responses:
|
|
'200':
|
|
description: List of export objects with identity profiles.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
description: Identity profile exported object.
|
|
properties:
|
|
version:
|
|
type: integer
|
|
example: 1
|
|
description: Version or object from the target service.
|
|
format: int32
|
|
self:
|
|
type: object
|
|
description: Self block for exported object.
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: Exported object's DTO type.
|
|
enum:
|
|
- ACCESS_PROFILE
|
|
- ACCESS_REQUEST_CONFIG
|
|
- ATTR_SYNC_SOURCE_CONFIG
|
|
- AUTH_ORG
|
|
- CAMPAIGN_FILTER
|
|
- FORM_DEFINITION
|
|
- GOVERNANCE_GROUP
|
|
- IDENTITY_OBJECT_CONFIG
|
|
- IDENTITY_PROFILE
|
|
- LIFECYCLE_STATE
|
|
- NOTIFICATION_TEMPLATE
|
|
- PASSWORD_POLICY
|
|
- PASSWORD_SYNC_GROUP
|
|
- PUBLIC_IDENTITIES_CONFIG
|
|
- ROLE
|
|
- RULE
|
|
- SEGMENT
|
|
- SERVICE_DESK_INTEGRATION
|
|
- SOD_POLICY
|
|
- SOURCE
|
|
- TAG
|
|
- TRANSFORM
|
|
- TRIGGER_SUBSCRIPTION
|
|
- WORKFLOW
|
|
example: SOURCE
|
|
id:
|
|
type: string
|
|
description: Exported object's ID.
|
|
example: 2c9180835d191a86015d28455b4b232a
|
|
name:
|
|
type: string
|
|
description: Exported object's display name.
|
|
example: HR Active Directory
|
|
object:
|
|
$ref: '#/paths/~1identity-profiles/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/IdentityProfile.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:identity-profile:read
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
$Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional)
|
|
$Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** (optional)
|
|
|
|
# Export Identity Profiles
|
|
|
|
try {
|
|
Export-IdentityProfiles
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Export-IdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-IdentityProfiles"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/identity-profiles/import:
|
|
post:
|
|
operationId: importIdentityProfiles
|
|
summary: Import Identity Profiles
|
|
description: This imports previously exported identity profiles.
|
|
tags:
|
|
- Identity Profiles
|
|
requestBody:
|
|
description: Previously exported Identity Profiles.
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1identity-profiles~1export/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/IdentityProfileExportedObject.yaml
|
|
responses:
|
|
'200':
|
|
description: The result of importing Identity Profiles.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: Import Object Response Body
|
|
description: Response model for import of a single object.
|
|
properties:
|
|
infos:
|
|
description: Informational messages returned from the target service on import.
|
|
type: array
|
|
items:
|
|
type: object
|
|
title: Config Import/Export Message
|
|
description: Message model for Config Import/Export.
|
|
properties:
|
|
key:
|
|
type: string
|
|
description: Message key.
|
|
example: UNKNOWN_REFERENCE_RESOLVER
|
|
text:
|
|
type: string
|
|
description: Message text.
|
|
example: 'Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]'
|
|
details:
|
|
type: object
|
|
description: Message details if any, in key:value pairs.
|
|
additionalProperties: true
|
|
example:
|
|
details: message details
|
|
required:
|
|
- key
|
|
- text
|
|
- details
|
|
warnings:
|
|
description: Warning messages returned from the target service on import.
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1identity-profiles~1import/post/responses/200/content/application~1json/schema/properties/infos/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/SpConfigMessage.yaml
|
|
errors:
|
|
description: Error messages returned from the target service on import.
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1identity-profiles~1import/post/responses/200/content/application~1json/schema/properties/infos/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/SpConfigMessage.yaml
|
|
importedObjects:
|
|
description: References to objects that were created or updated by the import.
|
|
type: array
|
|
items:
|
|
type: object
|
|
description: Object created or updated by import.
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: DTO type of object created or updated by import.
|
|
enum:
|
|
- IDENTITY_OBJECT_CONFIG
|
|
- IDENTITY_PROFILE
|
|
- RULE
|
|
- SOURCE
|
|
- TRANSFORM
|
|
- TRIGGER_SUBSCRIPTION
|
|
example: SOURCE
|
|
id:
|
|
type: string
|
|
description: ID of object created or updated by import.
|
|
example: 2c9180835d191a86015d28455b4b232a
|
|
name:
|
|
type: string
|
|
description: Display name of object created or updated by import.
|
|
example: HR Active Directory
|
|
required:
|
|
- infos
|
|
- warnings
|
|
- errors
|
|
- importedObjects
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:identity-profile:manage
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
# IdentityProfileExportedObject[] | Previously exported Identity Profiles.
|
|
$IdentityProfileExportedObject = @"{
|
|
"self" : {
|
|
"name" : "HR Active Directory",
|
|
"id" : "2c9180835d191a86015d28455b4b232a",
|
|
"type" : "SOURCE"
|
|
},
|
|
"version" : 1,
|
|
"object" : {
|
|
"owner" : {
|
|
"name" : "William Wilson",
|
|
"id" : "2c9180835d191a86015d28455b4b232a",
|
|
"type" : "IDENTITY"
|
|
},
|
|
"identityExceptionReportReference" : {
|
|
"reportName" : "My annual report",
|
|
"taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238"
|
|
},
|
|
"authoritativeSource" : {
|
|
"name" : "HR Active Directory",
|
|
"id" : "2c9180835d191a86015d28455b4b232a",
|
|
"type" : "SOURCE"
|
|
},
|
|
"hasTimeBasedAttr" : true,
|
|
"created" : "2015-05-28T14:07:17Z",
|
|
"description" : "My custom flat file profile",
|
|
"identityRefreshRequired" : true,
|
|
"identityCount" : 8,
|
|
"priority" : 10,
|
|
"identityAttributeConfig" : {
|
|
"attributeTransforms" : [ {
|
|
"transformDefinition" : {
|
|
"attributes" : {
|
|
"attributeName" : "e-mail",
|
|
"sourceName" : "MySource",
|
|
"sourceId" : "2c9180877a826e68017a8c0b03da1a53"
|
|
},
|
|
"type" : "accountAttribute"
|
|
},
|
|
"identityAttributeName" : "email"
|
|
}, {
|
|
"transformDefinition" : {
|
|
"attributes" : {
|
|
"attributeName" : "e-mail",
|
|
"sourceName" : "MySource",
|
|
"sourceId" : "2c9180877a826e68017a8c0b03da1a53"
|
|
},
|
|
"type" : "accountAttribute"
|
|
},
|
|
"identityAttributeName" : "email"
|
|
} ],
|
|
"enabled" : true
|
|
},
|
|
"name" : "aName",
|
|
"modified" : "2015-05-28T14:07:17Z",
|
|
"id" : "id12345"
|
|
}
|
|
}"@
|
|
|
|
|
|
# Import Identity Profiles
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToIdentityProfileExportedObject -Json $IdentityProfileExportedObject
|
|
Import-IdentityProfiles-IdentityProfileExportedObject $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Import-IdentityProfiles -IdentityProfileExportedObject $IdentityProfileExportedObject
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-IdentityProfiles"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/identity-profiles/identity-preview:
|
|
post:
|
|
operationId: showIdentityPreview
|
|
tags:
|
|
- Identity Profiles
|
|
summary: Generate Identity Profile Preview
|
|
description: |-
|
|
Use this API to generate a non-persisted preview of the identity object after applying `IdentityAttributeConfig` sent in request body.
|
|
This API only allows `accountAttribute`, `reference` and `rule` transform types in the `IdentityAttributeConfig` sent in the request body.
|
|
requestBody:
|
|
description: Identity Preview request body.
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
identityId:
|
|
type: string
|
|
format: uuid
|
|
example: 2c9180857893f12901789445619b0366
|
|
description: The Identity id
|
|
identityAttributeConfig:
|
|
$ref: '#/components/schemas/IdentityProfile/allOf/1/properties/identityAttributeConfig'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/IdentityAttributeConfig.yaml
|
|
responses:
|
|
'200':
|
|
description: A preview of the identity attributes after applying identity attributes config sent in request body.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
identity:
|
|
type: object
|
|
description: Identity's basic details.
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: Identity's DTO type.
|
|
enum:
|
|
- IDENTITY
|
|
example: IDENTITY
|
|
id:
|
|
type: string
|
|
description: Identity ID.
|
|
example: 2c7180a46faadee4016fb4e018c20642
|
|
name:
|
|
type: string
|
|
description: Identity's display name.
|
|
example: Michael Michaels
|
|
previewAttributes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Name of the attribute that is being previewed.
|
|
example: email
|
|
value:
|
|
type: string
|
|
description: Value that was derived during the preview.
|
|
example: email@mail.com
|
|
previousValue:
|
|
type: string
|
|
description: The value of the attribute before the preview.
|
|
example: oldEmail@mail.com
|
|
errorMessages:
|
|
$ref: '#/paths/~1access-request-status/get/responses/200/content/application~1json/schema/items/properties/errorMessages/items'
|
|
description: A list of errors that may have been encountered.
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ErrorMessageDtoList.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:identity-profile:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$IdentityPreviewRequest = @"
|
|
{
|
|
"identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
|
"identityAttributeConfig" : {
|
|
"attributeTransforms" : [ {
|
|
"transformDefinition" : {
|
|
"attributes" : {
|
|
"attributeName" : "e-mail",
|
|
"sourceName" : "MySource",
|
|
"sourceId" : "2c9180877a826e68017a8c0b03da1a53"
|
|
},
|
|
"type" : "accountAttribute"
|
|
},
|
|
"identityAttributeName" : "email"
|
|
}, {
|
|
"transformDefinition" : {
|
|
"attributes" : {
|
|
"attributeName" : "e-mail",
|
|
"sourceName" : "MySource",
|
|
"sourceId" : "2c9180877a826e68017a8c0b03da1a53"
|
|
},
|
|
"type" : "accountAttribute"
|
|
},
|
|
"identityAttributeName" : "email"
|
|
} ],
|
|
"enabled" : true
|
|
}
|
|
}
|
|
"@
|
|
|
|
# Generate Identity Profile Preview
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest
|
|
Show-IdentityPreview-IdentityPreviewRequest $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Show-IdentityPreview -IdentityPreviewRequest $IdentityPreviewRequest
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-IdentityPreview"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/identity-profiles/{identity-profile-id}:
|
|
get:
|
|
operationId: getIdentityProfile
|
|
tags:
|
|
- Identity Profiles
|
|
summary: Get single Identity Profile
|
|
description: This returns a single Identity Profile based on ID.
|
|
parameters:
|
|
- in: path
|
|
name: identity-profile-id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listIdentityProfiles
|
|
description: The Identity Profile ID.
|
|
example: 2b838de9-db9b-abcf-e646-d4f274ad4238
|
|
responses:
|
|
'200':
|
|
description: An Identity Profile object.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1identity-profiles/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/IdentityProfile.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:identity-profile:read
|
|
- applicationAuth:
|
|
- idn:identity-profile:read
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID.
|
|
|
|
# Get single Identity Profile
|
|
|
|
try {
|
|
Get-IdentityProfile-IdentityProfileId $IdentityProfileId
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-IdentityProfile -IdentityProfileId $IdentityProfileId
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityProfile"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
delete:
|
|
operationId: deleteIdentityProfile
|
|
tags:
|
|
- Identity Profiles
|
|
summary: Delete an Identity Profile
|
|
description: |-
|
|
This deletes an Identity Profile based on ID.
|
|
|
|
On success, this endpoint will return a reference to the bulk delete task result.
|
|
|
|
|
|
The following rights are required to access this endpoint: idn:identity-profile:delete
|
|
parameters:
|
|
- in: path
|
|
name: identity-profile-id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listIdentityProfiles
|
|
description: The Identity Profile ID.
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
responses:
|
|
'202':
|
|
description: Accepted - Returns a TaskResult object referencing the bulk delete job created.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1identity-profiles~1bulk-delete/post/responses/202/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/TaskResultSimplified.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:identity-profile:delete
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID.
|
|
|
|
# Delete an Identity Profile
|
|
|
|
try {
|
|
Remove-IdentityProfile-IdentityProfileId $IdentityProfileId
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Remove-IdentityProfile -IdentityProfileId $IdentityProfileId
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-IdentityProfile"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
patch:
|
|
operationId: updateIdentityProfile
|
|
tags:
|
|
- Identity Profiles
|
|
summary: Update the Identity Profile
|
|
description: |-
|
|
This updates the specified Identity Profile.
|
|
|
|
|
|
Some fields of the Schema cannot be updated. These fields are listed below:
|
|
* id
|
|
* name
|
|
* created
|
|
* modified
|
|
* identityCount
|
|
* identityRefreshRequired
|
|
* Authoritative Source and Identity Attribute Configuration cannot be modified at once.
|
|
parameters:
|
|
- in: path
|
|
name: identity-profile-id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listIdentityProfiles
|
|
description: The Identity Profile ID
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
requestBody:
|
|
required: true
|
|
description: A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
content:
|
|
application/json-patch+json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/JsonPatchOperation.yaml
|
|
examples:
|
|
add-attribute-transform:
|
|
summary: Add an attribute transform
|
|
value:
|
|
- op: add
|
|
path: /identityAttributeConfig/attributeTransforms/0
|
|
value:
|
|
identityAttributeName: location
|
|
transformDefinition:
|
|
type: accountAttribute
|
|
attributes:
|
|
sourceName: Employees
|
|
attributeName: location
|
|
sourceId: 2c91808878b7d63b0178c66ffcdc4ce4
|
|
responses:
|
|
'200':
|
|
description: The updated Identity Profile.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1identity-profiles/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/IdentityProfile.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:identity-profile:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID
|
|
# JsonPatchOperation[] | A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
$JsonPatchOperation = @"{
|
|
"op" : "replace",
|
|
"path" : "/description",
|
|
"value" : "New description"
|
|
}"@
|
|
|
|
|
|
# Update the Identity Profile
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
|
|
Update-IdentityProfile-IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Update-IdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $JsonPatchOperation
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-IdentityProfile"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/identity-profiles/{identity-profile-id}/default-identity-attribute-config:
|
|
get:
|
|
operationId: getDefaultIdentityAttributeConfig
|
|
tags:
|
|
- Identity Profiles
|
|
summary: Get default Identity Attribute Config
|
|
description: This returns the default identity attribute config.
|
|
parameters:
|
|
- in: path
|
|
name: identity-profile-id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listIdentityProfiles
|
|
description: The Identity Profile ID.
|
|
example: 2b838de9-db9b-abcf-e646-d4f274ad4238
|
|
responses:
|
|
'200':
|
|
description: An Identity Attribute Config object.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/IdentityProfile/allOf/1/properties/identityAttributeConfig'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/IdentityAttributeConfig.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:identity-profile:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID.
|
|
|
|
# Get default Identity Attribute Config
|
|
|
|
try {
|
|
Get-DefaultIdentityAttributeConfig-IdentityProfileId $IdentityProfileId
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-DefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-DefaultIdentityAttributeConfig"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/identity-profiles/{identity-profile-id}/process-identities:
|
|
post:
|
|
operationId: syncIdentityProfile
|
|
tags:
|
|
- Identity Profiles
|
|
summary: Process identities under profile
|
|
description: |-
|
|
Process identities under the profile
|
|
This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant's timezone to keep your identities synchronized.
|
|
This should only be run on identity profiles that have the `identityRefreshRequired` attribute set to `true`. If `identityRefreshRequired` is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh.
|
|
This operation will perform the following activities on all identities under the identity profile.
|
|
1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity's correct manager through manager correlation. 3. Updates the identity's access according to their assigned lifecycle state. 4. Updates the identity's access based on role assignment criteria.
|
|
externalDocs:
|
|
description: Learn more about manually processing identities here
|
|
url: https://documentation.sailpoint.com/saas/help/setup/identity_processing.html
|
|
parameters:
|
|
- in: path
|
|
name: identity-profile-id
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listIdentityProfiles
|
|
description: The Identity Profile ID to be processed
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
responses:
|
|
'202':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/202'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/202.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:identity-profile:refresh
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID to be processed
|
|
|
|
# Process identities under profile
|
|
|
|
try {
|
|
Sync-IdentityProfile-IdentityProfileId $IdentityProfileId
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Sync-IdentityProfile -IdentityProfileId $IdentityProfileId
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-IdentityProfile"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/managed-clients:
|
|
get:
|
|
tags:
|
|
- Managed Clients
|
|
summary: Get Managed Clients
|
|
description: List managed clients.
|
|
operationId: getManagedClients
|
|
parameters:
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
- in: query
|
|
name: filters
|
|
schema:
|
|
type: string
|
|
description: |-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
**id**: *eq*
|
|
|
|
**name**: *eq*
|
|
|
|
**clientId**: *eq*
|
|
|
|
**clusterId**: *eq*
|
|
required: false
|
|
example: name eq "client name"
|
|
responses:
|
|
'200':
|
|
description: Response with a list of managed clients, based on the specified query parameters.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
description: Managed Client
|
|
type: object
|
|
required:
|
|
- clientId
|
|
- clusterId
|
|
- description
|
|
- type
|
|
properties:
|
|
id:
|
|
description: ManagedClient ID
|
|
readOnly: true
|
|
nullable: true
|
|
type: string
|
|
example: 2c9180878eaf4204018eb019c3570003
|
|
alertKey:
|
|
description: ManagedClient alert key
|
|
readOnly: true
|
|
nullable: true
|
|
type: string
|
|
example: CLIENT_STATUS_NOT_CONFIGURED
|
|
apiGatewayBaseUrl:
|
|
nullable: true
|
|
type: string
|
|
cookbook:
|
|
nullable: true
|
|
type: string
|
|
ccId:
|
|
description: Previous CC ID to be used in data migration. (This field will be deleted after CC migration!)
|
|
nullable: true
|
|
type: integer
|
|
format: int64
|
|
example: 2248
|
|
clientId:
|
|
description: The client ID used in API management
|
|
type: string
|
|
example: 00be54a2-bb6d-402f-9159-beb2d5319347
|
|
clusterId:
|
|
description: Cluster ID that the ManagedClient is linked to
|
|
type: string
|
|
example: e1ff7bb24c934240bbf55e1aa39e41c5
|
|
description:
|
|
description: ManagedClient description
|
|
type: string
|
|
default: ''
|
|
example: A short description of the ManagedClient
|
|
ipAddress:
|
|
description: The public IP address of the ManagedClient
|
|
readOnly: true
|
|
nullable: true
|
|
type: string
|
|
example: 123.456.78.90
|
|
lastSeen:
|
|
description: When the ManagedClient was last seen by the server
|
|
readOnly: true
|
|
nullable: true
|
|
type: string
|
|
format: date-time
|
|
example: '2020-01-01T00:00:00.000000Z'
|
|
name:
|
|
description: ManagedClient name
|
|
nullable: true
|
|
type: string
|
|
default: VA-$clientId
|
|
example: aName
|
|
sinceLastSeen:
|
|
description: Milliseconds since the ManagedClient has polled the server
|
|
readOnly: true
|
|
nullable: true
|
|
type: string
|
|
example: 15000
|
|
status:
|
|
description: Status of the ManagedClient
|
|
readOnly: true
|
|
nullable: true
|
|
type: string
|
|
enum:
|
|
- NORMAL
|
|
- UNDEFINED
|
|
- NOT_CONFIGURED
|
|
- CONFIGURING
|
|
- WARNING
|
|
- ERROR
|
|
- FAILED
|
|
- null
|
|
example: NORMAL
|
|
type:
|
|
description: Type of the ManagedClient (VA, CCG)
|
|
type: string
|
|
example: VA
|
|
clusterType:
|
|
description: Cluster Type of the ManagedClient
|
|
readOnly: true
|
|
nullable: true
|
|
type: string
|
|
enum:
|
|
- null
|
|
- idn
|
|
- iai
|
|
- spConnectCluster
|
|
- sqsCluster
|
|
- das-rc
|
|
- das-pc
|
|
- das-dc
|
|
example: idn
|
|
vaDownloadUrl:
|
|
description: ManagedClient VA download URL
|
|
readOnly: true
|
|
nullable: true
|
|
type: string
|
|
example: aUrl
|
|
vaVersion:
|
|
description: Version that the ManagedClient's VA is running
|
|
readOnly: true
|
|
nullable: true
|
|
type: string
|
|
example: va-megapod-useast1-610-1621372012
|
|
secret:
|
|
description: Client's apiKey
|
|
nullable: true
|
|
type: string
|
|
example: ef878e15eaa8c8d3e2fa52f41125e2a0eeadadc6a14f931a33ad3e1b62d56381
|
|
createdAt:
|
|
description: The date/time this ManagedClient was created
|
|
example: '2023-08-04T20:48:01.865Z'
|
|
nullable: true
|
|
type: string
|
|
format: date-time
|
|
updatedAt:
|
|
description: The date/time this ManagedClient was last updated
|
|
example: '2023-08-04T20:48:01.865Z'
|
|
nullable: true
|
|
type: string
|
|
format: date-time
|
|
provisionStatus:
|
|
description: The provisioning status of the ManagedClient
|
|
readOnly: true
|
|
nullable: true
|
|
type: string
|
|
enum:
|
|
- null
|
|
- PROVISIONED
|
|
- DRAFT
|
|
example: PROVISIONED
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:remote-client:read
|
|
- idn:remote-client:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
$Filters = "name eq "client name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional)
|
|
|
|
# Get Managed Clients
|
|
|
|
try {
|
|
Get-ManagedClients
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-ManagedClients -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClients"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
post:
|
|
tags:
|
|
- Managed Clients
|
|
summary: Create Managed Client
|
|
description: |-
|
|
Create a new managed client.
|
|
The API returns a result that includes the managed client ID.
|
|
operationId: createManagedClient
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
description: Managed Client Request
|
|
type: object
|
|
required:
|
|
- clusterId
|
|
properties:
|
|
clusterId:
|
|
description: Cluster ID that the ManagedClient is linked to
|
|
type: string
|
|
example: aClusterId
|
|
description:
|
|
description: description for the ManagedClient to create
|
|
type: string
|
|
nullable: true
|
|
example: A short description of the ManagedClient
|
|
name:
|
|
description: name for the ManagedClient to create
|
|
type: string
|
|
nullable: true
|
|
example: aName
|
|
type:
|
|
description: Type of the ManagedClient (VA, CCG) to create
|
|
type: string
|
|
nullable: true
|
|
example: VA
|
|
responses:
|
|
'200':
|
|
description: Created managed client.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1managed-clients/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ManagedClient.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:remote-client:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$ManagedClientRequest = @"
|
|
{
|
|
"name" : "aName",
|
|
"description" : "A short description of the ManagedClient",
|
|
"clusterId" : "aClusterId",
|
|
"type" : "VA"
|
|
}
|
|
"@
|
|
|
|
# Create Managed Client
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest
|
|
New-ManagedClient-ManagedClientRequest $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# New-ManagedClient -ManagedClientRequest $ManagedClientRequest
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedClient"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/managed-clients/{id}:
|
|
get:
|
|
tags:
|
|
- Managed Clients
|
|
summary: Get Managed Client
|
|
description: 'Get managed client by ID. '
|
|
operationId: getManagedClient
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Managed client ID.
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getManagedClients
|
|
example: 4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: Managed client response.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1managed-clients/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ManagedClient.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:remote-client:read
|
|
- idn:remote-client:manage
|
|
- idn:managed-client-status:read
|
|
- idn:managed-client-status:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID.
|
|
|
|
# Get Managed Client
|
|
|
|
try {
|
|
Get-ManagedClient-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-ManagedClient -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClient"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
patch:
|
|
tags:
|
|
- Managed Clients
|
|
summary: Update Managed Client
|
|
description: Update an existing managed client.
|
|
operationId: updateManagedClient
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getManagedClients
|
|
description: Managed client ID.
|
|
example: 4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7
|
|
requestBody:
|
|
required: true
|
|
description: JSONPatch payload used to update the object.
|
|
content:
|
|
application/json-patch+json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/JsonPatchOperation.yaml
|
|
responses:
|
|
'200':
|
|
description: Updated managed client.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1managed-clients/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ManagedClient.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:remote-client:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID.
|
|
# JsonPatchOperation[] | JSONPatch payload used to update the object.
|
|
$JsonPatchOperation = @"{
|
|
"op" : "replace",
|
|
"path" : "/description",
|
|
"value" : "New description"
|
|
}"@
|
|
|
|
|
|
# Update Managed Client
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
|
|
Update-ManagedClient-Id $Id -JsonPatchOperation $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Update-ManagedClient -Id $Id -JsonPatchOperation $JsonPatchOperation
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedClient"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
delete:
|
|
operationId: deleteManagedClient
|
|
tags:
|
|
- Managed Clients
|
|
summary: Delete Managed Client
|
|
description: Delete an existing managed client.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getManagedClients
|
|
description: Managed client ID.
|
|
example: 4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7
|
|
responses:
|
|
'204':
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/204.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:remote-client:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID.
|
|
|
|
# Delete Managed Client
|
|
|
|
try {
|
|
Remove-ManagedClient-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Remove-ManagedClient -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ManagedClient"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/managed-clients/{id}/status:
|
|
get:
|
|
tags:
|
|
- Managed Clients
|
|
summary: Get Managed Client Status
|
|
description: Get a managed client's status, using its ID.
|
|
operationId: getManagedClientStatus
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Managed client ID to get status for.
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getManagedClients
|
|
schema:
|
|
type: string
|
|
example: aClientId
|
|
- name: type
|
|
in: query
|
|
description: Managed client type to get status for.
|
|
required: true
|
|
schema:
|
|
description: Managed Client type
|
|
type: string
|
|
example: CCG
|
|
nullable: true
|
|
enum:
|
|
- CCG
|
|
- VA
|
|
- INTERNAL
|
|
- IIQ_HARVESTER
|
|
- null
|
|
responses:
|
|
'200':
|
|
description: Response with the managed client status, with the given ID and type.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
description: Managed Client Status
|
|
type: object
|
|
required:
|
|
- body
|
|
- status
|
|
- type
|
|
- timestamp
|
|
properties:
|
|
body:
|
|
description: ManagedClientStatus body information
|
|
type: object
|
|
example:
|
|
alertKey: ''
|
|
id: '5678'
|
|
clusterId: '1234'
|
|
ccg_etag: ccg_etag123xyz456
|
|
ccg_pin: NONE
|
|
cookbook_etag: 20210420125956-20210511144538
|
|
hostname: megapod-useast1-secret-hostname.sailpoint.com
|
|
internal_ip: 127.0.0.1
|
|
lastSeen: '1620843964604'
|
|
sinceSeen: '14708'
|
|
sinceSeenMillis: '14708'
|
|
localDev: false
|
|
stacktrace: ''
|
|
state: null
|
|
status: NORMAL
|
|
uuid: null
|
|
product: idn
|
|
va_version: null
|
|
platform_version: '2'
|
|
os_version: 2345.3.1
|
|
os_type: flatcar
|
|
hypervisor: unknown
|
|
status:
|
|
type: string
|
|
description: Status of a Managed Client
|
|
enum:
|
|
- NORMAL
|
|
- UNDEFINED
|
|
- NOT_CONFIGURED
|
|
- CONFIGURING
|
|
- WARNING
|
|
- ERROR
|
|
- FAILED
|
|
example: NORMAL
|
|
type:
|
|
description: type of the Managed Client
|
|
$ref: '#/paths/~1managed-clients~1%7Bid%7D~1status/get/parameters/1/schema'
|
|
example: CCG
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ManagedClientType.yaml
|
|
timestamp:
|
|
description: timestamp on the Client Status update
|
|
type: string
|
|
format: date-time
|
|
example: '2020-01-01T00:00:00.000000Z'
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:managed-client-status:read
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "aClientId" # String | Managed client ID to get status for.
|
|
$Type = "CCG" # ManagedClientType | Managed client type to get status for.
|
|
|
|
# Get Managed Client Status
|
|
|
|
try {
|
|
Get-ManagedClientStatus-Id $Id -Type $Type
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-ManagedClientStatus -Id $Id -Type $Type
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClientStatus"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/managed-clusters:
|
|
get:
|
|
tags:
|
|
- Managed Clusters
|
|
summary: Get Managed Clusters
|
|
description: List current organization's managed clusters, based on request context.
|
|
operationId: getManagedClusters
|
|
parameters:
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
- in: query
|
|
name: filters
|
|
schema:
|
|
type: string
|
|
description: |-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
**operational**: *eq*
|
|
required: false
|
|
example: operational eq "operation"
|
|
responses:
|
|
'200':
|
|
description: Response with a list of managed clusters.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
description: Managed Cluster
|
|
type: object
|
|
required:
|
|
- id
|
|
- clientType
|
|
- ccgVersion
|
|
properties:
|
|
id:
|
|
description: ManagedCluster ID
|
|
type: string
|
|
example: e1ff7bb24c934240bbf55e1aa39e41c5
|
|
name:
|
|
description: ManagedCluster name
|
|
type: string
|
|
example: Managed Cluster Name
|
|
pod:
|
|
description: ManagedCluster pod
|
|
type: string
|
|
example: megapod-useast1
|
|
org:
|
|
description: ManagedCluster org
|
|
type: string
|
|
example: denali
|
|
type:
|
|
type: string
|
|
description: The Type of Cluster
|
|
example: idn
|
|
enum:
|
|
- idn
|
|
- iai
|
|
configuration:
|
|
description: ManagedProcess configuration map
|
|
type: object
|
|
additionalProperties:
|
|
type: string
|
|
nullable: true
|
|
example:
|
|
clusterExternalId: e1ff7bb24c934240bbf55e1aa39e41c5
|
|
clusterType: sqsCluster
|
|
gmtOffset: '-5'
|
|
keyPair:
|
|
description: Managed Cluster key pair for Cluster
|
|
type: object
|
|
properties:
|
|
publicKey:
|
|
nullable: true
|
|
description: ManagedCluster publicKey
|
|
type: string
|
|
example: '-----BEGIN PUBLIC KEY-----******-----END PUBLIC KEY-----'
|
|
publicKeyThumbprint:
|
|
nullable: true
|
|
description: ManagedCluster publicKeyThumbprint
|
|
type: string
|
|
example: 6CMlaJIV44-xJxcB3CJBjDUUn54
|
|
publicKeyCertificate:
|
|
nullable: true
|
|
description: ManagedCluster publicKeyCertificate
|
|
type: string
|
|
example: '-----BEGIN CERTIFICATE-----****-----END CERTIFICATE-----'
|
|
attributes:
|
|
description: Managed Cluster Attributes for Cluster Configuration. Supported Cluster Types [sqsCluster, spConnectCluster]
|
|
type: object
|
|
properties:
|
|
queue:
|
|
description: Managed Cluster key pair for Cluster
|
|
type: object
|
|
properties:
|
|
name:
|
|
description: ManagedCluster queue name
|
|
type: string
|
|
example: megapod-useast1-denali-lwt-cluster-1533
|
|
region:
|
|
description: ManagedCluster queue aws region
|
|
type: string
|
|
example: us-east-1
|
|
keystore:
|
|
nullable: true
|
|
description: ManagedCluster keystore for spConnectCluster type
|
|
type: string
|
|
example: /u3+7QAAAAIAAAABAAAAAQAvL3Byb3h5LWNsdXN0ZXIvMmM5MTgwODc3Yjg3MW
|
|
description:
|
|
description: ManagedCluster description
|
|
type: string
|
|
default: q
|
|
example: A short description of the managed cluster.
|
|
redis:
|
|
description: Managed Cluster Redis Configuration
|
|
type: object
|
|
properties:
|
|
redisHost:
|
|
description: ManagedCluster redisHost
|
|
type: string
|
|
example: megapod-useast1-shared-redis.cloud.sailpoint.com
|
|
redisPort:
|
|
description: ManagedCluster redisPort
|
|
type: integer
|
|
format: int32
|
|
example: 6379
|
|
clientType:
|
|
description: type of client for the ManagedCluster
|
|
$ref: '#/paths/~1managed-clients~1%7Bid%7D~1status/get/parameters/1/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ManagedClientType.yaml
|
|
ccgVersion:
|
|
description: CCG version used by the ManagedCluster
|
|
type: string
|
|
example: v01
|
|
pinnedConfig:
|
|
description: boolean flag indiacting whether or not the cluster configuration is pinned
|
|
type: boolean
|
|
default: false
|
|
example: false
|
|
logConfiguration:
|
|
description: client log configuration for the cluster
|
|
example: '{ "rootLevel": "WARN", "logLevels": { "foobar": "WARN" } }'
|
|
$ref: '#/paths/~1managed-clusters~1%7Bid%7D~1log-config/get/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ClientLogConfiguration.yaml
|
|
operational:
|
|
description: Whether or not the cluster is operational or not
|
|
type: boolean
|
|
default: false
|
|
example: false
|
|
status:
|
|
description: Cluster status
|
|
type: string
|
|
example: NORMAL
|
|
publicKeyCertificate:
|
|
nullable: true
|
|
description: Public key certificate
|
|
type: string
|
|
example: '-----BEGIN CERTIFICATE-----TCCAb2gAwIBAgIBADANBgkqhkiG9w0BAQsFADAuMQ0wCwYDVQQD-----END CERTIFICATE-----'
|
|
publicKeyThumbprint:
|
|
nullable: true
|
|
description: Public key thumbprint
|
|
type: string
|
|
example: obc6pLiulGbtZ
|
|
publicKey:
|
|
nullable: true
|
|
description: Public key
|
|
type: string
|
|
example: '-----BEGIN PUBLIC KEY-----jANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA3WgnsxP52MDgBTfHR+5n4-----END PUBLIC KEY-----'
|
|
alertKey:
|
|
description: Key describing any immediate cluster alerts
|
|
type: string
|
|
example: LIMITED_RESOURCES
|
|
clientIds:
|
|
type: array
|
|
description: List of clients in a cluster
|
|
items:
|
|
type: string
|
|
example:
|
|
- '1244'
|
|
- '1245'
|
|
serviceCount:
|
|
description: Number of services bound to a cluster
|
|
type: integer
|
|
format: int32
|
|
default: 0
|
|
example: 6
|
|
ccId:
|
|
description: CC ID only used in calling CC, will be removed without notice when Migration to CEGS is finished
|
|
type: string
|
|
default: '0'
|
|
example: '1533'
|
|
createdAt:
|
|
description: The date/time this cluster was created
|
|
example: '2023-08-04T20:48:01.865Z'
|
|
nullable: true
|
|
type: string
|
|
format: date-time
|
|
updatedAt:
|
|
description: The date/time this cluster was last updated
|
|
example: '2023-08-04T20:48:01.865Z'
|
|
nullable: true
|
|
type: string
|
|
format: date-time
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:remote-client:read
|
|
- idn:remote-client:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
$Filters = "operational eq "operation"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional)
|
|
|
|
# Get Managed Clusters
|
|
|
|
try {
|
|
Get-ManagedClusters
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-ManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClusters"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
post:
|
|
tags:
|
|
- Managed Clusters
|
|
summary: Create Create Managed Cluster
|
|
description: |-
|
|
Create a new Managed Cluster.
|
|
The API returns a result that includes the managed cluster ID.
|
|
operationId: createManagedCluster
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
description: Request to create Managed Cluster
|
|
type: object
|
|
required:
|
|
- name
|
|
properties:
|
|
name:
|
|
description: ManagedCluster name
|
|
type: string
|
|
nullable: false
|
|
example: Managed Cluster Name
|
|
type:
|
|
$ref: '#/paths/~1managed-clusters/get/responses/200/content/application~1json/schema/items/properties/type'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ManagedClusterTypes.yaml
|
|
configuration:
|
|
description: ManagedProcess configuration map
|
|
type: object
|
|
additionalProperties:
|
|
type: string
|
|
example:
|
|
clusterExternalId: externalId
|
|
ccgVersion: 77.0.0
|
|
description:
|
|
description: ManagedCluster description
|
|
type: string
|
|
nullable: true
|
|
example: A short description of the managed cluster.
|
|
responses:
|
|
'200':
|
|
description: Created managed cluster.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1managed-clusters/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ManagedCluster.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:remote-client:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$ManagedClusterRequest = @"
|
|
{
|
|
"configuration" : {
|
|
"clusterExternalId" : "externalId",
|
|
"ccgVersion" : "77.0.0"
|
|
},
|
|
"name" : "Managed Cluster Name",
|
|
"description" : "A short description of the managed cluster.",
|
|
"type" : "idn"
|
|
}
|
|
"@
|
|
|
|
# Create Create Managed Cluster
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest
|
|
New-ManagedCluster-ManagedClusterRequest $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# New-ManagedCluster -ManagedClusterRequest $ManagedClusterRequest
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedCluster"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/managed-clusters/{id}:
|
|
get:
|
|
tags:
|
|
- Managed Clusters
|
|
summary: Get Managed Cluster
|
|
description: Get a managed cluster by ID.
|
|
operationId: getManagedCluster
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Managed cluster ID.
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getManagedClusters
|
|
example: 2c9180897de347a2017de8859e8c5039
|
|
style: simple
|
|
explode: false
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: Response with managed cluster for the given ID.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1managed-clusters/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ManagedCluster.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:remote-client:read
|
|
- idn:remote-client:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID.
|
|
|
|
# Get Managed Cluster
|
|
|
|
try {
|
|
Get-ManagedCluster-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-ManagedCluster -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedCluster"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
patch:
|
|
tags:
|
|
- Managed Clusters
|
|
summary: Update Managed Cluster
|
|
description: Update an existing managed cluster.
|
|
operationId: updateManagedCluster
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getManagedClusters
|
|
description: Managed cluster ID.
|
|
example: 2c9180897de347a2017de8859e8c5039
|
|
requestBody:
|
|
required: true
|
|
description: JSONPatch payload used to update the object.
|
|
content:
|
|
application/json-patch+json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/JsonPatchOperation.yaml
|
|
responses:
|
|
'200':
|
|
description: Updated managed cluster.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1managed-clusters/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ManagedCluster.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:remote-client:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID.
|
|
# JsonPatchOperation[] | JSONPatch payload used to update the object.
|
|
$JsonPatchOperation = @"{
|
|
"op" : "replace",
|
|
"path" : "/description",
|
|
"value" : "New description"
|
|
}"@
|
|
|
|
|
|
# Update Managed Cluster
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
|
|
Update-ManagedCluster-Id $Id -JsonPatchOperation $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Update-ManagedCluster -Id $Id -JsonPatchOperation $JsonPatchOperation
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedCluster"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
delete:
|
|
operationId: deleteManagedCluster
|
|
tags:
|
|
- Managed Clusters
|
|
summary: Delete Managed Cluster
|
|
description: Delete an existing managed cluster.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getManagedClusters
|
|
description: Managed cluster ID.
|
|
example: 2c9180897de347a2017de8859e8c5039
|
|
- in: query
|
|
name: removeClients
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
required: false
|
|
description: Flag to determine the need to delete a cluster with clients.
|
|
example: false
|
|
responses:
|
|
'204':
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/204.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:remote-client:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID.
|
|
$RemoveClients = $false # Boolean | Flag to determine the need to delete a cluster with clients. (optional) (default to $false)
|
|
|
|
# Delete Managed Cluster
|
|
|
|
try {
|
|
Remove-ManagedCluster-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Remove-ManagedCluster -Id $Id -RemoveClients $RemoveClients
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ManagedCluster"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/managed-clusters/{id}/log-config:
|
|
get:
|
|
tags:
|
|
- Managed Clusters
|
|
summary: Get Managed Cluster Log Configuration
|
|
description: Get a managed cluster's log configuration.
|
|
operationId: getClientLogConfiguration
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: ID of managed cluster to get log configuration for.
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getManagedClusters
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
example: 2b838de9-db9b-abcf-e646-d4f274ad4238
|
|
responses:
|
|
'200':
|
|
description: Log configuration of managed cluster for given cluster ID.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
description: Client Runtime Logging Configuration
|
|
nullable: true
|
|
type: object
|
|
required:
|
|
- rootLevel
|
|
properties:
|
|
clientId:
|
|
description: Log configuration's client ID
|
|
type: string
|
|
example: 3a38a51992e8445ab51a549c0a70ee66
|
|
durationMinutes:
|
|
description: Duration in minutes for log configuration to remain in effect before resetting to defaults.
|
|
type: integer
|
|
format: int32
|
|
example: 120
|
|
default: 240
|
|
minimum: 5
|
|
maximum: 1440
|
|
expiration:
|
|
description: Expiration date-time of the log configuration request. Can be no greater than 24 hours from current date-time.
|
|
example: '2024-11-06T01:31:08.013164Z'
|
|
type: string
|
|
format: date-time
|
|
rootLevel:
|
|
description: Standard Log4j log level
|
|
type: string
|
|
example: INFO
|
|
enum:
|
|
- 'OFF'
|
|
- FATAL
|
|
- ERROR
|
|
- WARN
|
|
- INFO
|
|
- DEBUG
|
|
- TRACE
|
|
logLevels:
|
|
description: Mapping of identifiers to Standard Log Level values
|
|
type: object
|
|
example: INFO
|
|
additionalProperties:
|
|
default: INFO
|
|
example: TRACE
|
|
$ref: '#/paths/~1managed-clusters~1%7Bid%7D~1log-config/get/responses/200/content/application~1json/schema/properties/rootLevel'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/StandardLevel.yaml
|
|
'204':
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/204.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:remote-client:read
|
|
- idn:remote-client:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for.
|
|
|
|
# Get Managed Cluster Log Configuration
|
|
|
|
try {
|
|
Get-ClientLogConfiguration-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-ClientLogConfiguration -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ClientLogConfiguration"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
put:
|
|
tags:
|
|
- Managed Clusters
|
|
summary: Update Managed Cluster Log Configuration
|
|
description: Update a managed cluster's log configuration. You may only specify one of `durationMinutes` or `expiration`, up to 1440 minutes (24 hours) in the future. If neither is specified, the default value for `durationMinutes` is 240.
|
|
operationId: putClientLogConfiguration
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: ID of the managed cluster to update the log configuration for.
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getManagedClusters
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
example: 2b838de9-db9b-abcf-e646-d4f274ad4238
|
|
requestBody:
|
|
description: Client log configuration for the given managed cluster.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
oneOf:
|
|
- description: Client Runtime Logging Configuration
|
|
title: Set Duration Minutes
|
|
nullable: true
|
|
type: object
|
|
required:
|
|
- rootLevel
|
|
properties:
|
|
clientId:
|
|
description: Log configuration's client ID
|
|
type: string
|
|
example: 3a38a51992e8445ab51a549c0a70ee66
|
|
durationMinutes:
|
|
description: Duration in minutes for log configuration to remain in effect before resetting to defaults.
|
|
type: integer
|
|
format: int32
|
|
example: 120
|
|
default: 240
|
|
minimum: 5
|
|
maximum: 1440
|
|
rootLevel:
|
|
$ref: '#/paths/~1managed-clusters~1%7Bid%7D~1log-config/get/responses/200/content/application~1json/schema/properties/rootLevel'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/StandardLevel.yaml
|
|
logLevels:
|
|
$ref: '#/paths/~1managed-clusters~1%7Bid%7D~1log-config/get/responses/200/content/application~1json/schema/properties/logLevels'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/LogLevelSpec.yaml
|
|
- description: Client Runtime Logging Configuration
|
|
title: Set Expiration Date
|
|
nullable: true
|
|
type: object
|
|
required:
|
|
- rootLevel
|
|
properties:
|
|
clientId:
|
|
description: Log configuration's client ID
|
|
type: string
|
|
example: 3a38a51992e8445ab51a549c0a70ee66
|
|
expiration:
|
|
description: Expiration date-time of the log configuration request. Can be no greater than 24 hours from current date-time.
|
|
example: '2024-11-06T01:31:08.013164Z'
|
|
type: string
|
|
format: date-time
|
|
rootLevel:
|
|
$ref: '#/paths/~1managed-clusters~1%7Bid%7D~1log-config/get/responses/200/content/application~1json/schema/properties/rootLevel'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/StandardLevel.yaml
|
|
logLevels:
|
|
$ref: '#/paths/~1managed-clusters~1%7Bid%7D~1log-config/get/responses/200/content/application~1json/schema/properties/logLevels'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/LogLevelSpec.yaml
|
|
examples:
|
|
Duration Minutes:
|
|
summary: Duration Minutes
|
|
value:
|
|
clientId: 3a38a51992e8445ab51a549c0a70ee66
|
|
durationMinutes: 120
|
|
rootLevel: INFO
|
|
logLevels:
|
|
sailpoint.connector.ADLDAPConnector: TRACE
|
|
sailpoint.connector.JDBCConnector: DEBUG
|
|
Expiration:
|
|
summary: Expiration
|
|
value:
|
|
clientId: 3a38a51992e8445ab51a549c0a70ee66
|
|
expiration: '2024-11-06T01:31:08.013164Z'
|
|
rootLevel: INFO
|
|
logLevels:
|
|
sailpoint.connector.ADLDAPConnector: TRACE
|
|
sailpoint.connector.JDBCConnector: DEBUG
|
|
required: true
|
|
responses:
|
|
'200':
|
|
description: Response with updated client log configuration for the given managed cluster.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1managed-clusters~1%7Bid%7D~1log-config/get/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ClientLogConfiguration.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:remote-client:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of the managed cluster to update the log configuration for.
|
|
$PutClientLogConfigurationRequest = @"
|
|
|
|
"@
|
|
|
|
# Update Managed Cluster Log Configuration
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest
|
|
Send-ClientLogConfiguration-Id $Id -PutClientLogConfigurationRequest $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $PutClientLogConfigurationRequest
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ClientLogConfiguration"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/mfa/okta-verify/config:
|
|
get:
|
|
operationId: getMFAOktaConfig
|
|
tags:
|
|
- MFA Configuration
|
|
summary: Configuration of Okta MFA method
|
|
description: This API returns the configuration of an Okta MFA method.
|
|
security:
|
|
- userAuth:
|
|
- idn:mfa-configuration:read
|
|
- idn:mfa-configuration:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
responses:
|
|
'200':
|
|
description: The configuration of an Okta MFA method.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
mfaMethod:
|
|
type: string
|
|
nullable: true
|
|
description: Mfa method name
|
|
example: okta-verify
|
|
enabled:
|
|
type: boolean
|
|
description: If MFA method is enabled.
|
|
default: false
|
|
example: true
|
|
host:
|
|
type: string
|
|
nullable: true
|
|
description: The server host name or IP address of the MFA provider.
|
|
example: example.com
|
|
accessKey:
|
|
type: string
|
|
nullable: true
|
|
description: The secret key for authenticating requests to the MFA provider.
|
|
example: qw123Y3QlA5UqocYpdU3rEkzrK2D497y
|
|
identityAttribute:
|
|
type: string
|
|
nullable: true
|
|
description: Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider.
|
|
example: email
|
|
example:
|
|
mfaMethod: okta-verify
|
|
enabled: true
|
|
host: www.example.com
|
|
accessKey: d******Y
|
|
identityAttribute: email
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
|
|
# Configuration of Okta MFA method
|
|
|
|
try {
|
|
Get-MFAOktaConfig
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-MFAOktaConfig
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-MFAOktaConfig"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
put:
|
|
operationId: setMFAOktaConfig
|
|
tags:
|
|
- MFA Configuration
|
|
summary: Set Okta MFA configuration
|
|
description: This API sets the configuration of an Okta MFA method.
|
|
security:
|
|
- userAuth:
|
|
- idn:mfa-configuration:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1mfa~1okta-verify~1config/get/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/MfaOktaConfig.yaml
|
|
example:
|
|
mfaMethod: okta-verify
|
|
enabled: true
|
|
host: www.example.com
|
|
accessKey: dk778Y3QlA5UqocYpdU3rEkzrK2D497y
|
|
identityAttribute: email
|
|
responses:
|
|
'200':
|
|
description: MFA configuration of an Okta MFA method.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1mfa~1okta-verify~1config/get/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/MfaOktaConfig.yaml
|
|
example:
|
|
mfaMethod: okta-verify
|
|
enabled: true
|
|
host: www.example.com
|
|
accessKey: d******Y
|
|
identityAttribute: email
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$MfaOktaConfig = @"
|
|
{
|
|
"accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y",
|
|
"host" : "example.com",
|
|
"mfaMethod" : "okta-verify",
|
|
"enabled" : true,
|
|
"identityAttribute" : "email"
|
|
}
|
|
"@
|
|
|
|
# Set Okta MFA configuration
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig
|
|
Set-MFAOktaConfig-MfaOktaConfig $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Set-MFAOktaConfig -MfaOktaConfig $MfaOktaConfig
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-MFAOktaConfig"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/mfa/duo-web/config:
|
|
get:
|
|
operationId: getMFADuoConfig
|
|
tags:
|
|
- MFA Configuration
|
|
summary: Configuration of Duo MFA method
|
|
description: This API returns the configuration of an Duo MFA method.
|
|
security:
|
|
- userAuth:
|
|
- idn:mfa-configuration:read
|
|
- idn:mfa-configuration:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
responses:
|
|
'200':
|
|
description: The configuration of an Duo MFA method.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
mfaMethod:
|
|
type: string
|
|
nullable: true
|
|
description: Mfa method name
|
|
example: duo-web
|
|
enabled:
|
|
type: boolean
|
|
description: If MFA method is enabled.
|
|
default: false
|
|
example: true
|
|
host:
|
|
type: string
|
|
nullable: true
|
|
description: The server host name or IP address of the MFA provider.
|
|
example: example.com
|
|
accessKey:
|
|
type: string
|
|
nullable: true
|
|
description: The secret key for authenticating requests to the MFA provider.
|
|
example: qw123Y3QlA5UqocYpdU3rEkzrK2D497y
|
|
identityAttribute:
|
|
type: string
|
|
nullable: true
|
|
description: Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider.
|
|
example: email
|
|
configProperties:
|
|
description: A map with additional config properties for the given MFA method - duo-web.
|
|
type: object
|
|
nullable: true
|
|
additionalProperties: true
|
|
example:
|
|
skey: qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x
|
|
ikey: Q123WE45R6TY7890ZXCV
|
|
example:
|
|
mfaMethod: duo-web
|
|
enabled: true
|
|
host: www.example.com
|
|
accessKey: d******Y
|
|
identityAttribute: email
|
|
configProperties:
|
|
skey: 6******B
|
|
ikey: Q123WE45R6TY7890ZXCV
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
|
|
# Configuration of Duo MFA method
|
|
|
|
try {
|
|
Get-MFADuoConfig
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-MFADuoConfig
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-MFADuoConfig"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
put:
|
|
operationId: setMFADuoConfig
|
|
tags:
|
|
- MFA Configuration
|
|
summary: Set Duo MFA configuration
|
|
description: This API sets the configuration of an Duo MFA method.
|
|
security:
|
|
- userAuth:
|
|
- idn:mfa-configuration:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1mfa~1duo-web~1config/get/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/MfaDuoConfig.yaml
|
|
example:
|
|
mfaMethod: duo-web
|
|
enabled: true
|
|
host: www.example.com
|
|
accessKey: qw123Y3QlA5UqocYpdU3rEkzrK2D497y
|
|
identityAttribute: email
|
|
configProperties:
|
|
skey: 12q3WERlcUHWJmiMqyCXI3uOF7EaDJTbdeOp6E2B
|
|
ikey: Q123WE45R6TY7890ZXCV
|
|
responses:
|
|
'200':
|
|
description: MFA configuration of an Duo MFA method.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1mfa~1duo-web~1config/get/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/MfaDuoConfig.yaml
|
|
example:
|
|
mfaMethod: duo-web
|
|
enabled: true
|
|
host: www.example.com
|
|
accessKey: q******y
|
|
identityAttribute: email
|
|
configProperties:
|
|
skey: 1******B
|
|
ikey: Q123WE45R6TY7890ZXCV
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$MfaDuoConfig = @"
|
|
{
|
|
"accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y",
|
|
"host" : "example.com",
|
|
"configProperties" : {
|
|
"skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x",
|
|
"ikey" : "Q123WE45R6TY7890ZXCV"
|
|
},
|
|
"mfaMethod" : "duo-web",
|
|
"enabled" : true,
|
|
"identityAttribute" : "email"
|
|
}
|
|
"@
|
|
|
|
# Set Duo MFA configuration
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig
|
|
Set-MFADuoConfig-MfaDuoConfig $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Set-MFADuoConfig -MfaDuoConfig $MfaDuoConfig
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-MFADuoConfig"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/mfa/kba/config:
|
|
get:
|
|
operationId: getMFAKbaConfig
|
|
tags:
|
|
- MFA Configuration
|
|
summary: Configuration of KBA MFA method
|
|
description: This API returns the KBA configuration for MFA.
|
|
parameters:
|
|
- in: query
|
|
name: allLanguages
|
|
required: false
|
|
schema:
|
|
type: boolean
|
|
description: |-
|
|
Indicator whether the question text should be returned in all configured languages
|
|
* If true, the question text is returned in all languages that it is configured in.
|
|
* If false, the question text is returned in the user locale if available, else for the default locale.
|
|
* If not passed, it behaves the same way as passing this parameter as false
|
|
example: allLanguages=true
|
|
security:
|
|
- userAuth:
|
|
- idn:mfa-kba:read
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- USER
|
|
responses:
|
|
'200':
|
|
description: The configuration for KBA MFA method.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
description: KBA Configuration
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
nullable: false
|
|
description: KBA Question Id
|
|
example: 143cfd3b-c23f-426b-ae5f-d3db06fa5919
|
|
text:
|
|
type: string
|
|
nullable: false
|
|
description: KBA Question description
|
|
example: '[{"text":"Nouvelle question MFA -1 ?","locale":"fr"},{"text":"MFA new question -1 ?","locale":""}]'
|
|
hasAnswer:
|
|
type: boolean
|
|
nullable: false
|
|
description: Denotes whether the KBA question has an answer configured for any user in the tenant
|
|
example: true
|
|
numAnswers:
|
|
type: integer
|
|
format: int32
|
|
nullable: false
|
|
description: Denotes the number of KBA configurations for this question
|
|
example: 5
|
|
required:
|
|
- id
|
|
- text
|
|
- hasAnswer
|
|
- numAnswers
|
|
example:
|
|
- id: 143cfd3b-c23f-426b-ae5f-d3db06fa5919
|
|
text: MFA new question -1 ?
|
|
hasAnswer: false
|
|
numAnswers: 0
|
|
- id: '173421'
|
|
text: What is your alphanumeric PIN?
|
|
hasAnswer: false
|
|
numAnswers: 3
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$AllLanguages = $false # Boolean | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional)
|
|
|
|
# Configuration of KBA MFA method
|
|
|
|
try {
|
|
Get-MFAKbaConfig
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-MFAKbaConfig -AllLanguages $AllLanguages
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-MFAKbaConfig"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/mfa/kba/config/answers:
|
|
post:
|
|
operationId: setMFAKBAConfig
|
|
tags:
|
|
- MFA Configuration
|
|
summary: Set MFA KBA configuration
|
|
description: 'This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. '
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
nullable: false
|
|
description: Question Id
|
|
example: c54fee53-2d63-4fc5-9259-3e93b9994135
|
|
answer:
|
|
type: string
|
|
nullable: false
|
|
description: An answer for the KBA question
|
|
example: Your answer
|
|
required:
|
|
- id
|
|
- answer
|
|
example:
|
|
- id: '173423'
|
|
answer: 822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34
|
|
- id: c54fee53-2d63-4fc5-9259-3e93b9994135
|
|
answer: 9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08
|
|
security:
|
|
- userAuth:
|
|
- idn:mfa-kba:authenticate
|
|
x-sailpoint-userLevels:
|
|
- USER
|
|
responses:
|
|
'200':
|
|
description: The new KBA configuration for the user.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
nullable: false
|
|
description: Question Id
|
|
example: c54fee53-2d63-4fc5-9259-3e93b9994135
|
|
question:
|
|
type: string
|
|
nullable: false
|
|
description: Question description
|
|
example: '[{"text":"Nouvelle question MFA -1 ?","locale":"fr"},{"text":"MFA new question -1 ?","locale":""}]'
|
|
hasAnswer:
|
|
type: boolean
|
|
nullable: false
|
|
description: Denotes whether the KBA question has an answer configured for the current user
|
|
example: true
|
|
required:
|
|
- id
|
|
- question
|
|
- hasAnswer
|
|
example:
|
|
- id: 143cfd3b-c23f-426b-ae5f-d3db06fa5919
|
|
question: '[{"text":"Nouvelle question MFA -1 ?","locale":"fr"},{"text":"MFA new question -1 ?","locale":""}]'
|
|
hasAnswer: false
|
|
- id: '173421'
|
|
question: '[{"text":"What is your alphanumeric PIN?","locale":""}]'
|
|
hasAnswer: true
|
|
- id: c54fee53-2d63-4fc5-9259-3e93b9994135
|
|
question: '[{"text":"Nouvelle question MFA - 2 ?","locale":"fr"},{"text":"MFA new question - 2 ?","locale":""}]'
|
|
hasAnswer: true
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
# KbaAnswerRequestItem[] |
|
|
$KbaAnswerRequestItem = @"{
|
|
"answer" : "Your answer",
|
|
"id" : "c54fee53-2d63-4fc5-9259-3e93b9994135"
|
|
}"@
|
|
|
|
|
|
# Set MFA KBA configuration
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem
|
|
Set-MFAKBAConfig-KbaAnswerRequestItem $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Set-MFAKBAConfig -KbaAnswerRequestItem $KbaAnswerRequestItem
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-MFAKBAConfig"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/mfa/{method}/test:
|
|
get:
|
|
operationId: testMFAConfig
|
|
tags:
|
|
- MFA Configuration
|
|
summary: MFA method's test configuration
|
|
description: This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter.
|
|
security:
|
|
- userAuth:
|
|
- idn:mfa-configuration:read
|
|
- idn:mfa-configuration:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
parameters:
|
|
- in: path
|
|
name: method
|
|
schema:
|
|
type: string
|
|
example: okta-verify
|
|
nullable: false
|
|
enum:
|
|
- okta-verify
|
|
- duo-web
|
|
required: true
|
|
description: The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'.
|
|
responses:
|
|
'200':
|
|
description: The result of configuration test for the MFA provider.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
description: Response model for configuration test of a given MFA method
|
|
type: object
|
|
properties:
|
|
state:
|
|
type: string
|
|
enum:
|
|
- SUCCESS
|
|
- FAILED
|
|
description: The configuration test result.
|
|
example: SUCCESS
|
|
readOnly: true
|
|
error:
|
|
type: string
|
|
example: MFA Method is disabled.
|
|
description: The error message to indicate the failure of configuration test.
|
|
readOnly: true
|
|
example:
|
|
state: SUCCESS
|
|
error: null
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'.
|
|
|
|
# MFA method's test configuration
|
|
|
|
try {
|
|
Test-MFAConfig-Method $Method
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Test-MFAConfig -Method $Method
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-MFAConfig"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/mfa/{method}/delete:
|
|
delete:
|
|
operationId: deleteMFAConfig
|
|
tags:
|
|
- MFA Configuration
|
|
summary: Delete MFA method configuration
|
|
description: This API removes the configuration for the specified MFA method.
|
|
security:
|
|
- userAuth:
|
|
- idn:mfa-configuration:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
parameters:
|
|
- in: path
|
|
name: method
|
|
schema:
|
|
type: string
|
|
example: okta-verify
|
|
nullable: false
|
|
enum:
|
|
- okta-verify
|
|
- duo-web
|
|
required: true
|
|
description: The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'.
|
|
responses:
|
|
'200':
|
|
description: MFA configuration of an MFA method.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1mfa~1okta-verify~1config/get/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/MfaOktaConfig.yaml
|
|
example:
|
|
mfaMethod: okta-verify
|
|
enabled: true
|
|
host: www.example.com
|
|
accessKey: d******Y
|
|
identityAttribute: email
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'.
|
|
|
|
# Delete MFA method configuration
|
|
|
|
try {
|
|
Remove-MFAConfig-Method $Method
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Remove-MFAConfig -Method $Method
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-MFAConfig"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/mfa/okta-verify/verify:
|
|
post:
|
|
operationId: sendOktaVerifyRequest
|
|
tags:
|
|
- MFA Controller
|
|
summary: Verifying authentication via Okta method
|
|
description: This API Authenticates the user via Okta-Verify MFA method. Request requires a header called 'slpt-forwarding', and it must contain a remote IP Address of caller.
|
|
security:
|
|
- userAuth:
|
|
- idn:mfa:verify
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
userId:
|
|
type: string
|
|
nullable: false
|
|
description: User identifier for Verification request. The value of the user's attribute.
|
|
example: example@mail.com
|
|
required:
|
|
- userId
|
|
example:
|
|
userId: example@mail.com
|
|
responses:
|
|
'200':
|
|
description: The status of verification request.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
requestId:
|
|
type: string
|
|
nullable: true
|
|
description: The verificationPollRequest request ID
|
|
example: 089899f13a8f4da7824996191587bab9
|
|
status:
|
|
type: string
|
|
enum:
|
|
- PENDING
|
|
- SUCCESS
|
|
- FAILED
|
|
- LOCKOUT
|
|
- NOT_ENOUGH_DATA
|
|
description: MFA Authentication status
|
|
example: SUCCESS
|
|
error:
|
|
type: string
|
|
nullable: true
|
|
description: Error messages from MFA verification request
|
|
example: Unable to connect DUO Service during verification
|
|
example:
|
|
requestId: 089899f13a8f4da7824996191587bab9
|
|
status: SUCCESS
|
|
error: ''
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$OktaVerificationRequest = @"
|
|
{
|
|
"userId" : "example@mail.com"
|
|
}
|
|
"@
|
|
|
|
# Verifying authentication via Okta method
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToOktaVerificationRequest -Json $OktaVerificationRequest
|
|
Send-OktaVerifyRequest-OktaVerificationRequest $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Send-OktaVerifyRequest -OktaVerificationRequest $OktaVerificationRequest
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-OktaVerifyRequest"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/mfa/duo-web/verify:
|
|
post:
|
|
operationId: sendDuoVerifyRequest
|
|
tags:
|
|
- MFA Controller
|
|
summary: Verifying authentication via Duo method
|
|
description: This API Authenticates the user via Duo-Web MFA method.
|
|
security:
|
|
- userAuth:
|
|
- idn:mfa:verify
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
userId:
|
|
type: string
|
|
nullable: false
|
|
description: User id for Verification request.
|
|
example: 2c9180947f0ef465017f215cbcfd004b
|
|
signedResponse:
|
|
type: string
|
|
nullable: false
|
|
description: User id for Verification request.
|
|
example: AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2
|
|
required:
|
|
- userId
|
|
- signedResponse
|
|
example:
|
|
userId: 2c9180947f0ef465017f215cbcfd004b
|
|
signedResponse: AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2
|
|
responses:
|
|
'200':
|
|
description: The status of verification request.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1mfa~1okta-verify~1verify/post/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/VerificationResponse.yaml
|
|
example:
|
|
requestId: 089899f13a8f4da7824996191587bab9
|
|
status: SUCCESS
|
|
error: ''
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$DuoVerificationRequest = @"
|
|
{
|
|
"signedResponse" : "AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2",
|
|
"userId" : "2c9180947f0ef465017f215cbcfd004b"
|
|
}
|
|
"@
|
|
|
|
# Verifying authentication via Duo method
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToDuoVerificationRequest -Json $DuoVerificationRequest
|
|
Send-DuoVerifyRequest-DuoVerificationRequest $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Send-DuoVerifyRequest -DuoVerificationRequest $DuoVerificationRequest
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-DuoVerifyRequest"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/mfa/{method}/poll:
|
|
post:
|
|
operationId: pingVerificationStatus
|
|
tags:
|
|
- MFA Controller
|
|
summary: Polling MFA method by VerificationPollRequest
|
|
description: This API poll the VerificationPollRequest for the specified MFA method.
|
|
security:
|
|
- userAuth:
|
|
- idn:mfa:poll
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
parameters:
|
|
- in: path
|
|
name: method
|
|
schema:
|
|
type: string
|
|
example: okta-verify
|
|
nullable: false
|
|
enum:
|
|
- okta-verify
|
|
- duo-web
|
|
- kba
|
|
- token
|
|
- rsa
|
|
required: true
|
|
description: The name of the MFA method. The currently supported method names are 'okta-verify', 'duo-web', 'kba','token', 'rsa'
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
requestId:
|
|
type: string
|
|
nullable: false
|
|
description: Verification request Id
|
|
example: 089899f13a8f4da7824996191587bab9
|
|
required:
|
|
- requestId
|
|
example:
|
|
requestId: 089899f13a8f4da7824996191587bab9
|
|
responses:
|
|
'200':
|
|
description: MFA VerificationPollRequest status an MFA method.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1mfa~1okta-verify~1verify/post/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/VerificationResponse.yaml
|
|
example:
|
|
requestId: 089899f13a8f4da7824996191587bab9
|
|
status: PENDING
|
|
error: ''
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify', 'duo-web', 'kba','token', 'rsa'
|
|
$VerificationPollRequest = @"
|
|
{
|
|
"requestId" : "089899f13a8f4da7824996191587bab9"
|
|
}
|
|
"@
|
|
|
|
# Polling MFA method by VerificationPollRequest
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToVerificationPollRequest -Json $VerificationPollRequest
|
|
Ping-VerificationStatus-Method $Method -VerificationPollRequest $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Ping-VerificationStatus -Method $Method -VerificationPollRequest $VerificationPollRequest
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-VerificationStatus"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/mfa/kba/authenticate:
|
|
post:
|
|
operationId: sendKbaAnswers
|
|
tags:
|
|
- MFA Controller
|
|
summary: Authenticate KBA provided MFA method
|
|
description: This API Authenticate user in KBA MFA method.
|
|
security:
|
|
- userAuth:
|
|
- idn:mfa-kba:authenticate
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1mfa~1kba~1config~1answers/post/requestBody/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/KbaAnswerRequestItem.yaml
|
|
example:
|
|
- id: '173423'
|
|
answer: 822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34
|
|
- id: c54fee53-2d63-4fc5-9259-3e93b9994135
|
|
answer: 9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08
|
|
responses:
|
|
'200':
|
|
description: KBA authenticated status.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
kbaAuthResponseItems:
|
|
type: array
|
|
example:
|
|
- questionId: 089899f13a8f4da7824996191587bab9
|
|
isVerified: false
|
|
items:
|
|
type: object
|
|
properties:
|
|
questionId:
|
|
type: string
|
|
nullable: true
|
|
description: The KBA question id
|
|
example: 089899f13a8f4da7824996191587bab9
|
|
isVerified:
|
|
type: boolean
|
|
nullable: true
|
|
default: null
|
|
description: Return true if verified
|
|
example: true
|
|
status:
|
|
type: string
|
|
enum:
|
|
- PENDING
|
|
- SUCCESS
|
|
- FAILED
|
|
- LOCKOUT
|
|
- NOT_ENOUGH_DATA
|
|
description: MFA Authentication status
|
|
example: PENDING
|
|
example:
|
|
kbaAuthResponseItem:
|
|
- questionId: 089899f13a8f4da7824996191587bab9
|
|
IsVerified: false
|
|
- questionId: 089899f13a8f4da7824996191587bda8
|
|
IsVerified: true
|
|
status: PENDING
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
# KbaAnswerRequestItem[] |
|
|
$KbaAnswerRequestItem = @"{
|
|
"answer" : "Your answer",
|
|
"id" : "c54fee53-2d63-4fc5-9259-3e93b9994135"
|
|
}"@
|
|
|
|
|
|
# Authenticate KBA provided MFA method
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem
|
|
Send-KbaAnswers-KbaAnswerRequestItem $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Send-KbaAnswers -KbaAnswerRequestItem $KbaAnswerRequestItem
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-KbaAnswers"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/mfa/token/authenticate:
|
|
post:
|
|
operationId: sendTokenAuthRequest
|
|
tags:
|
|
- MFA Controller
|
|
summary: Authenticate Token provided MFA method
|
|
description: This API Authenticate user in Token MFA method.
|
|
security:
|
|
- userAuth:
|
|
- idn:mfa:verify
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
token:
|
|
nullable: false
|
|
type: string
|
|
description: Token value
|
|
example: '12345'
|
|
userAlias:
|
|
nullable: false
|
|
type: string
|
|
description: User alias from table spt_identity field named 'name'
|
|
example: will.albin
|
|
deliveryType:
|
|
nullable: false
|
|
type: string
|
|
enum:
|
|
- SMS_PERSONAL
|
|
- VOICE_PERSONAL
|
|
- SMS_WORK
|
|
- VOICE_WORK
|
|
- EMAIL_WORK
|
|
- EMAIL_PERSONAL
|
|
description: Token delivery type
|
|
example: EMAIL_WORK
|
|
required:
|
|
- token
|
|
- userAlias
|
|
- deliveryType
|
|
example:
|
|
token: '12345'
|
|
userAlias: will.albin
|
|
deliveryType: EMAIL_WORK
|
|
responses:
|
|
'200':
|
|
description: Token authenticated status.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
status:
|
|
type: string
|
|
enum:
|
|
- PENDING
|
|
- SUCCESS
|
|
- FAILED
|
|
- LOCKOUT
|
|
- NOT_ENOUGH_DATA
|
|
description: MFA Authentication status
|
|
example: PENDING
|
|
example:
|
|
status: PENDING
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$TokenAuthRequest = @"
|
|
{
|
|
"userAlias" : "will.albin",
|
|
"deliveryType" : "EMAIL_WORK",
|
|
"token" : "12345"
|
|
}
|
|
"@
|
|
|
|
# Authenticate Token provided MFA method
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToTokenAuthRequest -Json $TokenAuthRequest
|
|
Send-TokenAuthRequest-TokenAuthRequest $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Send-TokenAuthRequest -TokenAuthRequest $TokenAuthRequest
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-TokenAuthRequest"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/mfa/token/send:
|
|
post:
|
|
operationId: createSendToken
|
|
tags:
|
|
- MFA Controller
|
|
summary: Create and send user token
|
|
description: This API send token request.
|
|
security:
|
|
- userAuth:
|
|
- idn:mfa:send
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
userAlias:
|
|
nullable: false
|
|
type: string
|
|
description: User alias from table spt_identity field named 'name'
|
|
example: will.albin
|
|
deliveryType:
|
|
nullable: false
|
|
type: string
|
|
enum:
|
|
- SMS_PERSONAL
|
|
- VOICE_PERSONAL
|
|
- SMS_WORK
|
|
- VOICE_WORK
|
|
- EMAIL_WORK
|
|
- EMAIL_PERSONAL
|
|
description: Token delivery type
|
|
example: EMAIL_WORK
|
|
required:
|
|
- userAlias
|
|
- deliveryType
|
|
example:
|
|
userAlias: will.albin
|
|
deliveryType: EMAIL_WORK
|
|
responses:
|
|
'200':
|
|
description: Token send status.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
requestId:
|
|
type: string
|
|
nullable: true
|
|
description: The token request ID
|
|
example: 089899f13a8f4da7824996191587bab9
|
|
status:
|
|
type: string
|
|
enum:
|
|
- SUCCESS
|
|
- FAILED
|
|
description: Status of sending token
|
|
example: SUCCESS
|
|
errorMessage:
|
|
type: string
|
|
nullable: true
|
|
description: Error messages from token send request
|
|
example: Unable to sent text message
|
|
example:
|
|
requestId: 089899f13a8f4da7824996191587bab9
|
|
status: SUCCESS
|
|
errorMessage: ''
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$SendTokenRequest = @"
|
|
{
|
|
"userAlias" : "will.albin",
|
|
"deliveryType" : "EMAIL_WORK"
|
|
}
|
|
"@
|
|
|
|
# Create and send user token
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToSendTokenRequest -Json $SendTokenRequest
|
|
New-SendToken-SendTokenRequest $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# New-SendToken -SendTokenRequest $SendTokenRequest
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SendToken"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/non-employee-records:
|
|
post:
|
|
operationId: createNonEmployeeRecord
|
|
tags:
|
|
- Non-Employee Lifecycle Management
|
|
summary: Create Non-Employee Record
|
|
description: |-
|
|
This request will create a non-employee record.
|
|
Requires role context of `idn:nesr:create`
|
|
requestBody:
|
|
description: Non-Employee record creation request body.
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
accountName:
|
|
type: string
|
|
description: Requested identity account name.
|
|
example: william.smith
|
|
firstName:
|
|
type: string
|
|
description: Non-Employee's first name.
|
|
example: William
|
|
lastName:
|
|
type: string
|
|
description: Non-Employee's last name.
|
|
example: Smith
|
|
email:
|
|
type: string
|
|
description: Non-Employee's email.
|
|
example: william.smith@example.com
|
|
phone:
|
|
type: string
|
|
description: Non-Employee's phone.
|
|
example: '5125555555'
|
|
manager:
|
|
type: string
|
|
description: The account ID of a valid identity to serve as this non-employee's manager.
|
|
example: jane.doe
|
|
sourceId:
|
|
type: string
|
|
description: Non-Employee's source id.
|
|
example: 2c91808568c529c60168cca6f90c1313
|
|
data:
|
|
type: object
|
|
additionalProperties:
|
|
type: string
|
|
description: Additional attributes for a non-employee. Up to 10 custom attributes can be added.
|
|
example:
|
|
description: Auditing
|
|
startDate:
|
|
type: string
|
|
format: date-time
|
|
description: Non-Employee employment start date.
|
|
example: '2020-03-24T00:00:00-05:00'
|
|
endDate:
|
|
type: string
|
|
format: date-time
|
|
description: Non-Employee employment end date.
|
|
example: '2021-03-25T00:00:00-05:00'
|
|
required:
|
|
- accountName
|
|
- firstName
|
|
- lastName
|
|
- email
|
|
- phone
|
|
- manager
|
|
- sourceId
|
|
- startDate
|
|
- endDate
|
|
responses:
|
|
'200':
|
|
description: Created non-employee record.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: UUID
|
|
description: Non-Employee record id.
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
accountName:
|
|
type: string
|
|
description: Requested identity account name.
|
|
example: Abby.Smith
|
|
firstName:
|
|
type: string
|
|
description: Non-Employee's first name.
|
|
example: William
|
|
lastName:
|
|
type: string
|
|
description: Non-Employee's last name.
|
|
example: Smith
|
|
email:
|
|
type: string
|
|
description: Non-Employee's email.
|
|
example: william.smith@example.com
|
|
phone:
|
|
type: string
|
|
description: Non-Employee's phone.
|
|
example: '5125555555'
|
|
manager:
|
|
type: string
|
|
description: The account ID of a valid identity to serve as this non-employee's manager.
|
|
example: jane.doe
|
|
sourceId:
|
|
type: string
|
|
description: Non-Employee's source id.
|
|
example: 2c91808568c529c60168cca6f90c1313
|
|
data:
|
|
type: object
|
|
additionalProperties:
|
|
type: string
|
|
description: Additional attributes for a non-employee. Up to 10 custom attributes can be added.
|
|
example:
|
|
description: Auditing
|
|
startDate:
|
|
type: string
|
|
format: date-time
|
|
description: Non-Employee employment start date.
|
|
example: '2019-08-23T18:52:59.162Z'
|
|
endDate:
|
|
type: string
|
|
format: date-time
|
|
description: Non-Employee employment end date.
|
|
example: '2020-08-23T18:52:59.162Z'
|
|
modified:
|
|
type: string
|
|
format: date-time
|
|
description: When the request was last modified.
|
|
example: '2019-08-23T18:52:59.162Z'
|
|
created:
|
|
type: string
|
|
format: date-time
|
|
description: When the request was created.
|
|
example: '2019-08-23T18:40:35.772Z'
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$NonEmployeeRequestBody = @"
|
|
{
|
|
"sourceId" : "2c91808568c529c60168cca6f90c1313",
|
|
"firstName" : "William",
|
|
"lastName" : "Smith",
|
|
"manager" : "jane.doe",
|
|
"data" : {
|
|
"description" : "Auditing"
|
|
},
|
|
"accountName" : "william.smith",
|
|
"phone" : "5125555555",
|
|
"endDate" : "2021-03-25T00:00:00-05:00",
|
|
"email" : "william.smith@example.com",
|
|
"startDate" : "2020-03-24T00:00:00-05:00"
|
|
}
|
|
"@
|
|
|
|
# Create Non-Employee Record
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody
|
|
New-NonEmployeeRecord-NonEmployeeRequestBody $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# New-NonEmployeeRecord -NonEmployeeRequestBody $NonEmployeeRequestBody
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-NonEmployeeRecord"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
get:
|
|
operationId: listNonEmployeeRecords
|
|
security:
|
|
- userAuth: []
|
|
tags:
|
|
- Non-Employee Lifecycle Management
|
|
summary: List Non-Employee Records
|
|
description: |-
|
|
This gets a list of non-employee records. There are two contextual uses for this endpoint:
|
|
1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees.
|
|
2. The user is an account manager, in which case they can get a list of the non-employees that they manage.
|
|
parameters:
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
- in: query
|
|
name: sorters
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: comma-separated
|
|
example: accountName,sourceId
|
|
description: |-
|
|
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
|
|
|
Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified**
|
|
- in: query
|
|
name: filters
|
|
required: false
|
|
schema:
|
|
type: string
|
|
example: sourceId eq "2c91808568c529c60168cca6f90c1313"
|
|
description: |-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
**sourceId**: *eq*
|
|
responses:
|
|
'200':
|
|
description: Non-Employee record objects
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1non-employee-records/post/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeRecord.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
$Sorters = "accountName,sourceId" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (optional)
|
|
$Filters = "sourceId eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional)
|
|
|
|
# List Non-Employee Records
|
|
|
|
try {
|
|
Get-NonEmployeeRecords
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-NonEmployeeRecords -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeRecords"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/non-employee-records/{id}:
|
|
get:
|
|
operationId: getNonEmployeeRecord
|
|
tags:
|
|
- Non-Employee Lifecycle Management
|
|
summary: Get a Non-Employee Record
|
|
description: |-
|
|
This gets a non-employee record.
|
|
Requires role context of `idn:nesr:read`
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
description: Non-Employee record id (UUID)
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listNonEmployeeRecords
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: Non-Employee record object
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1non-employee-records/post/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeRecord.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID)
|
|
|
|
# Get a Non-Employee Record
|
|
|
|
try {
|
|
Get-NonEmployeeRecord-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-NonEmployeeRecord -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeRecord"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
put:
|
|
operationId: updateNonEmployeeRecord
|
|
security:
|
|
- userAuth: []
|
|
tags:
|
|
- Non-Employee Lifecycle Management
|
|
summary: Update Non-Employee Record
|
|
description: |-
|
|
This request will update a non-employee record. There are two contextual uses for this endpoint:
|
|
1. The user has the role context of `idn:nesr:update`, in which case they
|
|
update all available fields.
|
|
2. The user is owner of the source, in this case they can only update the
|
|
end date.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
description: Non-employee record id (UUID)
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listNonEmployeeRecords
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
description: Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields.
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1non-employee-records/post/requestBody/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeRequestBody.yaml
|
|
responses:
|
|
'200':
|
|
description: An updated non-employee record.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1non-employee-records/post/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeRecord.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-employee record id (UUID)
|
|
$NonEmployeeRequestBody = @"
|
|
{
|
|
"sourceId" : "2c91808568c529c60168cca6f90c1313",
|
|
"firstName" : "William",
|
|
"lastName" : "Smith",
|
|
"manager" : "jane.doe",
|
|
"data" : {
|
|
"description" : "Auditing"
|
|
},
|
|
"accountName" : "william.smith",
|
|
"phone" : "5125555555",
|
|
"endDate" : "2021-03-25T00:00:00-05:00",
|
|
"email" : "william.smith@example.com",
|
|
"startDate" : "2020-03-24T00:00:00-05:00"
|
|
}
|
|
"@
|
|
|
|
# Update Non-Employee Record
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody
|
|
Update-NonEmployeeRecord-Id $Id -NonEmployeeRequestBody $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Update-NonEmployeeRecord -Id $Id -NonEmployeeRequestBody $NonEmployeeRequestBody
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-NonEmployeeRecord"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
patch:
|
|
operationId: patchNonEmployeeRecord
|
|
security:
|
|
- userAuth: []
|
|
tags:
|
|
- Non-Employee Lifecycle Management
|
|
summary: Patch Non-Employee Record
|
|
description: |-
|
|
This request will patch a non-employee record. There are two contextual uses for this endpoint:
|
|
1. The user has the role context of `idn:nesr:update`, in which case they
|
|
update all available fields.
|
|
2. The user is owner of the source, in this case they can only update the
|
|
end date.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
description: Non-employee record id (UUID)
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listNonEmployeeRecords
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
description: A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields.
|
|
required: true
|
|
content:
|
|
application/json-patch+json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/JsonPatchOperation.yaml
|
|
example:
|
|
- op: replace
|
|
path: /endDate
|
|
value: '2019-08-23T18:40:35.772Z'
|
|
responses:
|
|
'200':
|
|
description: A patched non-employee record.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1non-employee-records/post/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeRecord.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-employee record id (UUID)
|
|
# JsonPatchOperation[] | A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields.
|
|
$JsonPatchOperation = @"{
|
|
"op" : "replace",
|
|
"path" : "/description",
|
|
"value" : "New description"
|
|
}"@
|
|
|
|
|
|
# Patch Non-Employee Record
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
|
|
Update-NonEmployeeRecord-Id $Id -JsonPatchOperation $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Update-NonEmployeeRecord -Id $Id -JsonPatchOperation $JsonPatchOperation
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-NonEmployeeRecord"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
delete:
|
|
operationId: deleteNonEmployeeRecord
|
|
tags:
|
|
- Non-Employee Lifecycle Management
|
|
summary: Delete Non-Employee Record
|
|
description: |-
|
|
This request will delete a non-employee record.
|
|
Requires role context of `idn:nesr:delete`
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
description: Non-Employee record id (UUID)
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listNonEmployeeRecords
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'204':
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/204.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID)
|
|
|
|
# Delete Non-Employee Record
|
|
|
|
try {
|
|
Remove-NonEmployeeRecord-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Remove-NonEmployeeRecord -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeRecord"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/non-employee-records/bulk-delete:
|
|
post:
|
|
operationId: deleteNonEmployeeRecordsInBulk
|
|
tags:
|
|
- Non-Employee Lifecycle Management
|
|
summary: Delete Multiple Non-Employee Records
|
|
description: This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete`
|
|
requestBody:
|
|
description: Non-Employee bulk delete request body.
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
ids:
|
|
description: List of non-employee ids.
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
example:
|
|
- 2b838de9-db9b-abcf-e646-d4f274ad4238
|
|
- 2d838de9-db9b-abcf-e646-d4f274ad4238
|
|
required:
|
|
- ids
|
|
responses:
|
|
'204':
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/204.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$DeleteNonEmployeeRecordsInBulkRequest = @"
|
|
|
|
"@
|
|
|
|
# Delete Multiple Non-Employee Records
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToDeleteNonEmployeeRecordsInBulkRequest -Json $DeleteNonEmployeeRecordsInBulkRequest
|
|
Remove-NonEmployeeRecordsInBulk-DeleteNonEmployeeRecordsInBulkRequest $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Remove-NonEmployeeRecordsInBulk -DeleteNonEmployeeRecordsInBulkRequest $DeleteNonEmployeeRecordsInBulkRequest
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeRecordsInBulk"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/non-employee-requests:
|
|
post:
|
|
operationId: createNonEmployeeRequest
|
|
security:
|
|
- userAuth: []
|
|
tags:
|
|
- Non-Employee Lifecycle Management
|
|
summary: Create Non-Employee Request
|
|
description: This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source.
|
|
requestBody:
|
|
description: Non-Employee creation request body
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1non-employee-records/post/requestBody/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeRequestBody.yaml
|
|
responses:
|
|
'200':
|
|
description: Non-Employee request creation object
|
|
content:
|
|
application/json:
|
|
schema:
|
|
allOf:
|
|
- type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: UUID
|
|
description: Non-Employee source id.
|
|
example: a0303682-5e4a-44f7-bdc2-6ce6112549c1
|
|
sourceId:
|
|
type: string
|
|
description: Source Id associated with this non-employee source.
|
|
example: 2c91808568c529c60168cca6f90c1313
|
|
name:
|
|
type: string
|
|
description: Source name associated with this non-employee source.
|
|
example: Retail
|
|
description:
|
|
type: string
|
|
description: Source description associated with this non-employee source.
|
|
example: Source description
|
|
- type: object
|
|
properties:
|
|
accountName:
|
|
type: string
|
|
description: Requested identity account name.
|
|
example: william.smith
|
|
firstName:
|
|
type: string
|
|
description: Non-Employee's first name.
|
|
example: William
|
|
lastName:
|
|
type: string
|
|
description: Non-Employee's last name.
|
|
example: Smith
|
|
email:
|
|
type: string
|
|
description: Non-Employee's email.
|
|
example: william.smith@example.com
|
|
phone:
|
|
type: string
|
|
description: Non-Employee's phone.
|
|
example: '5125555555'
|
|
manager:
|
|
type: string
|
|
description: The account ID of a valid identity to serve as this non-employee's manager.
|
|
example: jane.doe
|
|
nonEmployeeSource:
|
|
$ref: '#/paths/~1non-employee-requests/post/responses/200/content/application~1json/schema/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeSourceLite.yaml
|
|
data:
|
|
type: object
|
|
additionalProperties:
|
|
type: string
|
|
description: Additional attributes for a non-employee. Up to 10 custom attributes can be added.
|
|
example:
|
|
description: Auditing
|
|
approvalItems:
|
|
description: List of approval item for the request
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: UUID
|
|
description: Non-Employee approval item id
|
|
example: 2c1e388b-1e55-4b0a-ab5c-897f1204159c
|
|
approver:
|
|
$ref: '#/paths/~1non-employee-sources~1%7BsourceId%7D/get/responses/200/content/application~1json/schema/allOf/1/properties/approvers/items'
|
|
description: Reference to the associated Identity
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeIdentityReferenceWithId.yaml
|
|
accountName:
|
|
type: string
|
|
description: Requested identity account name
|
|
example: test.account
|
|
approvalStatus:
|
|
$ref: '#/paths/~1non-employee-requests/post/responses/200/content/application~1json/schema/allOf/1/properties/approvalStatus'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/ApprovalStatus.yaml
|
|
approvalOrder:
|
|
type: number
|
|
description: Approval order
|
|
example: 1
|
|
format: float
|
|
comment:
|
|
type: string
|
|
description: comment of approver
|
|
example: I approve
|
|
modified:
|
|
type: string
|
|
format: date-time
|
|
description: When the request was last modified.
|
|
example: '2019-08-23T18:52:59.162Z'
|
|
created:
|
|
type: string
|
|
format: date-time
|
|
description: When the request was created.
|
|
example: '2019-08-23T18:40:35.772Z'
|
|
approvalStatus:
|
|
type: string
|
|
enum:
|
|
- APPROVED
|
|
- REJECTED
|
|
- PENDING
|
|
- NOT_READY
|
|
- CANCELLED
|
|
description: Enum representing the non-employee request approval status
|
|
example: APPROVED
|
|
comment:
|
|
type: string
|
|
description: Comment of requester
|
|
example: approved
|
|
completionDate:
|
|
type: string
|
|
format: date-time
|
|
description: When the request was completely approved.
|
|
example: '2020-03-24T11:11:41.139-05:00'
|
|
startDate:
|
|
type: string
|
|
format: date-time
|
|
description: Non-Employee employment start date.
|
|
example: '2020-03-24T00:00:00-05:00'
|
|
endDate:
|
|
type: string
|
|
format: date-time
|
|
description: Non-Employee employment end date.
|
|
example: '2021-03-25T00:00:00-05:00'
|
|
modified:
|
|
type: string
|
|
format: date-time
|
|
description: When the request was last modified.
|
|
example: '2020-03-24T11:11:41.139-05:00'
|
|
created:
|
|
type: string
|
|
format: date-time
|
|
description: When the request was created.
|
|
example: '2020-03-24T11:11:41.139-05:00'
|
|
'400':
|
|
description: Client Error - Returned if the request body is invalid.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/400/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ErrorResponseDto.yaml
|
|
examples:
|
|
400.1 Bad Request Content:
|
|
description: Response for bad request content
|
|
value:
|
|
detailCode: 400.1 Bad Request Content
|
|
trackingId: e7eab60924f64aa284175b9fa3309599
|
|
messages:
|
|
- locale: en
|
|
localeOrigin: REQUEST
|
|
text: firstName is required; accountName is required;
|
|
400.1.409 Reference conflict:
|
|
description: Response for reference conflict
|
|
value:
|
|
detailCode: 400.1.409 Reference conflict
|
|
trackingId: e7eab60924f64aa284175b9fa3309599
|
|
messages:
|
|
- locale: en
|
|
localeOrigin: REQUEST
|
|
text: Unable to create Non-Employee because the accountName "existed" is already being used.
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$NonEmployeeRequestBody = @"
|
|
{
|
|
"sourceId" : "2c91808568c529c60168cca6f90c1313",
|
|
"firstName" : "William",
|
|
"lastName" : "Smith",
|
|
"manager" : "jane.doe",
|
|
"data" : {
|
|
"description" : "Auditing"
|
|
},
|
|
"accountName" : "william.smith",
|
|
"phone" : "5125555555",
|
|
"endDate" : "2021-03-25T00:00:00-05:00",
|
|
"email" : "william.smith@example.com",
|
|
"startDate" : "2020-03-24T00:00:00-05:00"
|
|
}
|
|
"@
|
|
|
|
# Create Non-Employee Request
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody
|
|
New-NonEmployeeRequest-NonEmployeeRequestBody $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# New-NonEmployeeRequest -NonEmployeeRequestBody $NonEmployeeRequestBody
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-NonEmployeeRequest"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
get:
|
|
operationId: listNonEmployeeRequests
|
|
security:
|
|
- userAuth: []
|
|
tags:
|
|
- Non-Employee Lifecycle Management
|
|
summary: List Non-Employee Requests
|
|
description: |-
|
|
This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter:
|
|
1. The user has the role context of `idn:nesr:read`, in which case he or
|
|
she may request a list non-employee requests assigned to a particular account manager by passing in that manager's id.
|
|
2. The current user is an account manager, in which case "me" should be
|
|
provided as the `requested-for` value. This will provide the user with a list of the non-employee requests in the source(s) he or she manages.
|
|
parameters:
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
- in: query
|
|
name: requested-for
|
|
required: true
|
|
schema:
|
|
type: string
|
|
example: e136567de87e4d029e60b3c3c55db56d
|
|
description: The identity for whom the request was made. *me* indicates the current user.
|
|
- in: query
|
|
name: sorters
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: comma-separated
|
|
example: created,approvalStatus
|
|
description: |-
|
|
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
|
|
|
Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate**
|
|
- in: query
|
|
name: filters
|
|
required: false
|
|
schema:
|
|
type: string
|
|
example: sourceId eq "2c91808568c529c60168cca6f90c1313"
|
|
description: |-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
**sourceId**: *eq*
|
|
responses:
|
|
'200':
|
|
description: List of non-employee request objects.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1non-employee-requests/post/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeRequest.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$RequestedFor = "e136567de87e4d029e60b3c3c55db56d" # String | The identity for whom the request was made. *me* indicates the current user.
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
$Sorters = "created,approvalStatus" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional)
|
|
$Filters = "sourceId eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional)
|
|
|
|
# List Non-Employee Requests
|
|
|
|
try {
|
|
Get-NonEmployeeRequests-RequestedFor $RequestedFor
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-NonEmployeeRequests -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeRequests"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/non-employee-requests/{id}:
|
|
get:
|
|
operationId: getNonEmployeeRequest
|
|
security:
|
|
- userAuth: []
|
|
tags:
|
|
- Non-Employee Lifecycle Management
|
|
summary: Get a Non-Employee Request
|
|
description: |-
|
|
This gets a non-employee request.
|
|
There are two contextual uses for this endpoint:
|
|
1. The user has the role context of `idn:nesr:read`, in this case the user
|
|
can get the non-employee request for any user.
|
|
2. The user must be the owner of the non-employee request.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
description: Non-Employee request id (UUID)
|
|
example: ac110005-7156-1150-8171-5b292e3e0084
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listNonEmployeeRequests
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: Non-Employee request object.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1non-employee-requests/post/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeRequest.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id (UUID)
|
|
|
|
# Get a Non-Employee Request
|
|
|
|
try {
|
|
Get-NonEmployeeRequest-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-NonEmployeeRequest -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeRequest"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
delete:
|
|
operationId: deleteNonEmployeeRequest
|
|
tags:
|
|
- Non-Employee Lifecycle Management
|
|
summary: Delete Non-Employee Request
|
|
description: |-
|
|
This request will delete a non-employee request.
|
|
Requires role context of `idn:nesr:delete`
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
description: Non-Employee request id in the UUID format
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listNonEmployeeRequests
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
example: ac110005-7156-1150-8171-5b292e3e0084
|
|
responses:
|
|
'204':
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/204.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id in the UUID format
|
|
|
|
# Delete Non-Employee Request
|
|
|
|
try {
|
|
Remove-NonEmployeeRequest-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Remove-NonEmployeeRequest -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeRequest"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/non-employee-requests/summary/{requested-for}:
|
|
get:
|
|
operationId: getNonEmployeeRequestSummary
|
|
security:
|
|
- userAuth: []
|
|
tags:
|
|
- Non-Employee Lifecycle Management
|
|
summary: Get Summary of Non-Employee Requests
|
|
description: |-
|
|
This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter:
|
|
1. The user has the role context of `idn:nesr:read`, in which case he or
|
|
she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager's id.
|
|
2. The current user is an account manager, in which case "me" should be
|
|
provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages.
|
|
parameters:
|
|
- in: path
|
|
name: requested-for
|
|
description: The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use "me" instead to indicate the current user.
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listNonEmployeeRecords
|
|
schema:
|
|
type: string
|
|
format: uuid (if user is Org Admin)
|
|
example: 2c91808280430dfb0180431a59440460
|
|
responses:
|
|
'200':
|
|
description: Non-Employee request summary object.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
approved:
|
|
type: integer
|
|
description: The number of approved non-employee requests on all sources that *requested-for* user manages.
|
|
example: 2
|
|
format: int32
|
|
rejected:
|
|
type: integer
|
|
description: The number of rejected non-employee requests on all sources that *requested-for* user manages.
|
|
example: 2
|
|
format: int32
|
|
pending:
|
|
type: integer
|
|
description: The number of pending non-employee requests on all sources that *requested-for* user manages.
|
|
example: 2
|
|
format: int32
|
|
nonEmployeeCount:
|
|
type: integer
|
|
description: The number of non-employee records on all sources that *requested-for* user manages.
|
|
example: 2
|
|
format: int32
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use ""me"" instead to indicate the current user.
|
|
|
|
# Get Summary of Non-Employee Requests
|
|
|
|
try {
|
|
Get-NonEmployeeRequestSummary-RequestedFor $RequestedFor
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-NonEmployeeRequestSummary -RequestedFor $RequestedFor
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeRequestSummary"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/non-employee-sources:
|
|
post:
|
|
operationId: createNonEmployeeSource
|
|
tags:
|
|
- Non-Employee Lifecycle Management
|
|
summary: Create Non-Employee Source
|
|
description: This request will create a non-employee source. Requires role context of `idn:nesr:create`
|
|
requestBody:
|
|
description: Non-Employee source creation request body.
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Name of non-employee source.
|
|
example: Retail
|
|
description:
|
|
type: string
|
|
description: Description of non-employee source.
|
|
example: Source description
|
|
owner:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: UUID
|
|
description: Identity id.
|
|
example: 2c91808570313110017040b06f344ec9
|
|
required:
|
|
- id
|
|
managementWorkgroup:
|
|
type: string
|
|
description: The ID for the management workgroup that contains source sub-admins
|
|
example: '123299'
|
|
approvers:
|
|
description: List of approvers.
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1non-employee-sources/post/requestBody/content/application~1json/schema/properties/owner'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeIdnUserRequest.yaml
|
|
maxItems: 3
|
|
accountManagers:
|
|
description: List of account managers.
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1non-employee-sources/post/requestBody/content/application~1json/schema/properties/owner'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeIdnUserRequest.yaml
|
|
maxItems: 10
|
|
required:
|
|
- owner
|
|
- name
|
|
- description
|
|
responses:
|
|
'200':
|
|
description: Created non-employee source.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/paths/~1non-employee-sources~1%7BsourceId%7D/get/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeSource.yaml
|
|
- type: object
|
|
properties:
|
|
cloudExternalId:
|
|
type: string
|
|
description: Legacy ID used for sources from the V1 API. This attribute will be removed from a future version of the API and will not be considered a breaking change. No clients should rely on this ID always being present.
|
|
example: '99999'
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$NonEmployeeSourceRequestBody = @"
|
|
{
|
|
"owner" : {
|
|
"id" : "2c91808570313110017040b06f344ec9"
|
|
},
|
|
"managementWorkgroup" : "123299",
|
|
"accountManagers" : [ {
|
|
"id" : "2c91808570313110017040b06f344ec9"
|
|
}, {
|
|
"id" : "2c91808570313110017040b06f344ec9"
|
|
}, {
|
|
"id" : "2c91808570313110017040b06f344ec9"
|
|
}, {
|
|
"id" : "2c91808570313110017040b06f344ec9"
|
|
}, {
|
|
"id" : "2c91808570313110017040b06f344ec9"
|
|
} ],
|
|
"name" : "Retail",
|
|
"description" : "Source description",
|
|
"approvers" : [ {
|
|
"id" : "2c91808570313110017040b06f344ec9"
|
|
}, {
|
|
"id" : "2c91808570313110017040b06f344ec9"
|
|
}, {
|
|
"id" : "2c91808570313110017040b06f344ec9"
|
|
} ]
|
|
}
|
|
"@
|
|
|
|
# Create Non-Employee Source
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody
|
|
New-NonEmployeeSource-NonEmployeeSourceRequestBody $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# New-NonEmployeeSource -NonEmployeeSourceRequestBody $NonEmployeeSourceRequestBody
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-NonEmployeeSource"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
get:
|
|
operationId: listNonEmployeeSources
|
|
security:
|
|
- userAuth: []
|
|
tags:
|
|
- Non-Employee Lifecycle Management
|
|
summary: List Non-Employee Sources
|
|
description: |-
|
|
This gets a list of non-employee sources. There are two contextual uses for the requested-for path parameter:
|
|
1. The user has the role context of `idn:nesr:read`, in which case he or
|
|
she may request a list sources assigned to a particular account manager by passing in that manager's id.
|
|
2. The current user is an account manager, in which case "me" should be
|
|
provided as the `requested-for` value. This will provide the user with a list of the sources that he or she owns.
|
|
parameters:
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
- in: query
|
|
name: requested-for
|
|
required: true
|
|
schema:
|
|
type: string
|
|
example: me
|
|
description: The identity for whom the request was made. *me* indicates the current user.
|
|
- in: query
|
|
name: non-employee-count
|
|
required: false
|
|
example: true
|
|
schema:
|
|
type: boolean
|
|
description: The flag to determine whether return a non-employee count associate with source.
|
|
- in: query
|
|
name: sorters
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: comma-separated
|
|
example: name,created
|
|
description: |-
|
|
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
|
|
|
Sorting is supported for the following fields: **name, created, sourceId**
|
|
responses:
|
|
'200':
|
|
description: List of non-employee sources objects.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
allOf:
|
|
- $ref: '#/paths/~1non-employee-sources~1%7BsourceId%7D/get/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeSource.yaml
|
|
- type: object
|
|
properties:
|
|
nonEmployeeCount:
|
|
type: integer
|
|
description: Number of non-employee records associated with this source.
|
|
format: int32
|
|
example: 120
|
|
nullable: true
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$RequestedFor = "me" # String | The identity for whom the request was made. *me* indicates the current user.
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
$NonEmployeeCount = $true # Boolean | The flag to determine whether return a non-employee count associate with source. (optional)
|
|
$Sorters = "name,created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional)
|
|
|
|
# List Non-Employee Sources
|
|
|
|
try {
|
|
Get-NonEmployeeSources-RequestedFor $RequestedFor
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-NonEmployeeSources -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeSources"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/non-employee-sources/{sourceId}:
|
|
get:
|
|
operationId: getNonEmployeeSource
|
|
security:
|
|
- userAuth: []
|
|
tags:
|
|
- Non-Employee Lifecycle Management
|
|
summary: Get a Non-Employee Source
|
|
description: |-
|
|
This gets a non-employee source. There are two contextual uses for the requested-for path parameter:
|
|
1. The user has the role context of `idn:nesr:read`, in which case he or
|
|
she may request any source.
|
|
2. The current user is an account manager, in which case the user can only
|
|
request sources that they own.
|
|
parameters:
|
|
- in: path
|
|
name: sourceId
|
|
description: Source Id
|
|
example: 2c91808b7c28b350017c2a2ec5790aa1
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listNonEmployeeSources
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: Non-Employee source object.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/paths/~1non-employee-requests/post/responses/200/content/application~1json/schema/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeSourceLite.yaml
|
|
- type: object
|
|
properties:
|
|
approvers:
|
|
description: List of approvers
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
enum:
|
|
- GOVERNANCE_GROUP
|
|
- IDENTITY
|
|
example: IDENTITY
|
|
description: Identifies if the identity is a normal identity or a governance group
|
|
id:
|
|
type: string
|
|
description: Identity id
|
|
example: 5168015d32f890ca15812c9180835d2e
|
|
accountManagers:
|
|
description: List of account managers
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1non-employee-sources~1%7BsourceId%7D/get/responses/200/content/application~1json/schema/allOf/1/properties/approvers/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeIdentityReferenceWithId.yaml
|
|
modified:
|
|
type: string
|
|
format: date-time
|
|
description: When the request was last modified.
|
|
example: '2019-08-23T18:52:59.162Z'
|
|
created:
|
|
type: string
|
|
format: date-time
|
|
description: When the request was created.
|
|
example: '2019-08-23T18:40:35.772Z'
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$SourceId = "2c91808b7c28b350017c2a2ec5790aa1" # String | Source Id
|
|
|
|
# Get a Non-Employee Source
|
|
|
|
try {
|
|
Get-NonEmployeeSource-SourceId $SourceId
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-NonEmployeeSource -SourceId $SourceId
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeSource"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
patch:
|
|
operationId: patchNonEmployeeSource
|
|
tags:
|
|
- Non-Employee Lifecycle Management
|
|
summary: Patch a Non-Employee Source
|
|
description: 'patch a non-employee source. (partial update) <br/> Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`.'
|
|
parameters:
|
|
- in: path
|
|
name: sourceId
|
|
description: Source Id
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listNonEmployeeSources
|
|
schema:
|
|
type: string
|
|
example: e136567de87e4d029e60b3c3c55db56d
|
|
requestBody:
|
|
description: A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
required: true
|
|
content:
|
|
application/json-patch+json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/JsonPatchOperation.yaml
|
|
example:
|
|
- op: replace
|
|
path: /name
|
|
value:
|
|
new name: null
|
|
- op: replace
|
|
path: /approvers
|
|
value:
|
|
- 2c91809f703bb37a017040a2fe8748c7
|
|
- 48b1f463c9e8427db5a5071bd81914b8
|
|
responses:
|
|
'200':
|
|
description: A patched non-employee source object.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1non-employee-sources~1%7BsourceId%7D/get/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeSource.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id
|
|
# JsonPatchOperation[] | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
$JsonPatchOperation = @"{
|
|
"op" : "replace",
|
|
"path" : "/description",
|
|
"value" : "New description"
|
|
}"@
|
|
|
|
|
|
# Patch a Non-Employee Source
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
|
|
Update-NonEmployeeSource-SourceId $SourceId -JsonPatchOperation $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Update-NonEmployeeSource -SourceId $SourceId -JsonPatchOperation $JsonPatchOperation
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-NonEmployeeSource"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
delete:
|
|
operationId: deleteNonEmployeeSource
|
|
tags:
|
|
- Non-Employee Lifecycle Management
|
|
summary: Delete Non-Employee Source
|
|
description: This request will delete a non-employee source. Requires role context of `idn:nesr:delete`.
|
|
parameters:
|
|
- in: path
|
|
name: sourceId
|
|
description: Source Id
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listNonEmployeeSources
|
|
schema:
|
|
type: string
|
|
example: e136567de87e4d029e60b3c3c55db56d
|
|
responses:
|
|
'204':
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/204.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id
|
|
|
|
# Delete Non-Employee Source
|
|
|
|
try {
|
|
Remove-NonEmployeeSource-SourceId $SourceId
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Remove-NonEmployeeSource -SourceId $SourceId
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeSource"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/non-employee-sources/{id}/non-employees/download:
|
|
get:
|
|
operationId: exportNonEmployeeRecords
|
|
tags:
|
|
- Non-Employee Lifecycle Management
|
|
summary: Exports Non-Employee Records to CSV
|
|
description: This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read`
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
description: Source Id (UUID)
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listNonEmployeeSources
|
|
schema:
|
|
type: string
|
|
example: e136567de87e4d029e60b3c3c55db56d
|
|
responses:
|
|
'200':
|
|
description: Exported CSV
|
|
content:
|
|
text/csv:
|
|
example: |
|
|
accountName,firstName,lastName,phone,email,manager,startDate,endDate
|
|
Jon.Smith, Jon, Smith, 555-555-5555, jon@jon.doe.nope.com, Jim Smith, 2020-04-05T08:00:00-10:00,2020-08-07T19:00:00-10:00
|
|
William.Chaffin, William, Chaffin, 555-555-5555, william@chaffins.nope.com, Bertram Chaffin, 2020-04-05T08:00:00-10:00,2020-08-07T19:00:00-10:00
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID)
|
|
|
|
# Exports Non-Employee Records to CSV
|
|
|
|
try {
|
|
Export-NonEmployeeRecords-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Export-NonEmployeeRecords -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-NonEmployeeRecords"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/non-employee-sources/{id}/non-employee-bulk-upload:
|
|
post:
|
|
operationId: importNonEmployeeRecordsInBulk
|
|
security:
|
|
- userAuth:
|
|
- idn:nelm:manage
|
|
tags:
|
|
- Non-Employee Lifecycle Management
|
|
summary: Imports, or Updates, Non-Employee Records
|
|
description: This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create`
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
description: Source Id (UUID)
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listNonEmployeeSources
|
|
schema:
|
|
type: string
|
|
example: e136567de87e4d029e60b3c3c55db56d
|
|
requestBody:
|
|
content:
|
|
multipart/form-data:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
data:
|
|
type: string
|
|
format: binary
|
|
required:
|
|
- data
|
|
responses:
|
|
'202':
|
|
description: The CSV was accepted to be bulk inserted now or at a later time.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The bulk upload job's ID. (UUID)
|
|
example: 2c91808568c529c60168cca6f90cffff
|
|
sourceId:
|
|
type: string
|
|
description: The ID of the source to bulk-upload non-employees to. (UUID)
|
|
example: 2c91808568c529c60168cca6f90c1313
|
|
created:
|
|
type: string
|
|
format: date-time
|
|
description: The date-time the job was submitted.
|
|
example: '2019-08-23T18:52:59.162Z'
|
|
modified:
|
|
type: string
|
|
format: date-time
|
|
description: The date-time that the job was last updated.
|
|
example: '2019-08-23T18:52:59.162Z'
|
|
status:
|
|
type: string
|
|
enum:
|
|
- PENDING
|
|
- IN_PROGRESS
|
|
- COMPLETED
|
|
- ERROR
|
|
description: |
|
|
Returns the following values indicating the progress or result of the bulk upload job.
|
|
"PENDING" means the job is queued and waiting to be processed.
|
|
"IN_PROGRESS" means the job is currently being processed.
|
|
"COMPLETED" means the job has been completed without any errors.
|
|
"ERROR" means the job failed to process with errors.
|
|
example: PENDING
|
|
'400':
|
|
description: |
|
|
Client Error - Returned if the request body is invalid.
|
|
The response body will contain the list of specific errors with one on each line.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/400/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ErrorResponseDto.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID)
|
|
$Data = # System.IO.FileInfo |
|
|
|
|
# Imports, or Updates, Non-Employee Records
|
|
|
|
try {
|
|
Import-NonEmployeeRecordsInBulk-Id $Id -Data $Data
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Import-NonEmployeeRecordsInBulk -Id $Id -Data $Data
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-NonEmployeeRecordsInBulk"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/non-employee-sources/{id}/non-employee-bulk-upload/status:
|
|
get:
|
|
operationId: getNonEmployeeBulkUploadStatus
|
|
tags:
|
|
- Non-Employee Lifecycle Management
|
|
summary: Obtain the status of bulk upload on the source
|
|
description: |
|
|
The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source.
|
|
Requires role context of `idn:nesr:read`
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
description: Source ID (UUID)
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listNonEmployeeSources
|
|
schema:
|
|
type: string
|
|
example: e136567de87e4d029e60b3c3c55db56d
|
|
responses:
|
|
'200':
|
|
description: Status of the newest bulk-upload job, if any.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
status:
|
|
type: string
|
|
enum:
|
|
- PENDING
|
|
- IN_PROGRESS
|
|
- COMPLETED
|
|
- ERROR
|
|
description: |
|
|
Returns the following values indicating the progress or result of the bulk upload job.
|
|
"PENDING" means the job is queued and waiting to be processed.
|
|
"IN_PROGRESS" means the job is currently being processed.
|
|
"COMPLETED" means the job has been completed without any errors.
|
|
"ERROR" means the job failed to process with errors.
|
|
null means job has been submitted to the source.
|
|
example: PENDING
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source ID (UUID)
|
|
|
|
# Obtain the status of bulk upload on the source
|
|
|
|
try {
|
|
Get-NonEmployeeBulkUploadStatus-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-NonEmployeeBulkUploadStatus -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeBulkUploadStatus"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/non-employee-sources/{id}/schema-attributes-template/download:
|
|
get:
|
|
operationId: exportNonEmployeeSourceSchemaTemplate
|
|
tags:
|
|
- Non-Employee Lifecycle Management
|
|
summary: Exports Source Schema Template
|
|
description: This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read`
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
description: Source Id (UUID)
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listNonEmployeeSources
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: Exported Source Schema Template
|
|
content:
|
|
text/csv:
|
|
example: |
|
|
accountName,firstName,lastName,phone,email,manager,startDate,endDate
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id (UUID)
|
|
|
|
# Exports Source Schema Template
|
|
|
|
try {
|
|
Export-NonEmployeeSourceSchemaTemplate-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Export-NonEmployeeSourceSchemaTemplate -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-NonEmployeeSourceSchemaTemplate"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/non-employee-approvals:
|
|
get:
|
|
operationId: listNonEmployeeApprovals
|
|
security:
|
|
- userAuth: []
|
|
tags:
|
|
- Non-Employee Lifecycle Management
|
|
summary: Get List of Non-Employee Approval Requests
|
|
description: |-
|
|
This gets a list of non-employee approval requests.
|
|
There are two contextual uses for this endpoint:
|
|
1. The user has the role context of `idn:nesr:read`, in which case they
|
|
can list the approvals for any approver.
|
|
2. The user owns the requested approval.
|
|
parameters:
|
|
- in: query
|
|
name: requested-for
|
|
schema:
|
|
type: string
|
|
description: The identity for whom the request was made. *me* indicates the current user.
|
|
required: false
|
|
example: 2c91808280430dfb0180431a59440460
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
- in: query
|
|
name: filters
|
|
schema:
|
|
type: string
|
|
description: |-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
**approvalStatus**: *eq*
|
|
example: approvalStatus eq "Pending"
|
|
required: false
|
|
- in: query
|
|
name: sorters
|
|
schema:
|
|
type: string
|
|
format: comma-separated
|
|
description: |-
|
|
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
|
|
|
Sorting is supported for the following fields: **created, modified**
|
|
required: false
|
|
example: created
|
|
responses:
|
|
'200':
|
|
description: List of approval items.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
allOf:
|
|
- $ref: '#/paths/~1non-employee-requests/post/responses/200/content/application~1json/schema/allOf/1/properties/approvalItems/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeApprovalItemBase.yaml
|
|
- type: object
|
|
properties:
|
|
nonEmployeeRequest:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: UUID
|
|
description: Non-Employee request id.
|
|
example: ac110005-7156-1150-8171-5b292e3e0084
|
|
requester:
|
|
$ref: '#/paths/~1non-employee-sources~1%7BsourceId%7D/get/responses/200/content/application~1json/schema/allOf/1/properties/approvers/items'
|
|
example:
|
|
type: IDENTITY
|
|
id: 2c9180866166b5b0016167c32ef31a66
|
|
name: William Smith
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeIdentityReferenceWithId.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity for whom the request was made. *me* indicates the current user. (optional)
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
$Filters = "approvalStatus eq "Pending"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **approvalStatus**: *eq* (optional)
|
|
$Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional)
|
|
|
|
# Get List of Non-Employee Approval Requests
|
|
|
|
try {
|
|
Get-NonEmployeeApprovals
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-NonEmployeeApprovals -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeApprovals"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/non-employee-approvals/{id}:
|
|
get:
|
|
operationId: getNonEmployeeApproval
|
|
security:
|
|
- userAuth: []
|
|
tags:
|
|
- Non-Employee Lifecycle Management
|
|
summary: Get a non-employee approval item detail
|
|
description: |-
|
|
Gets a non-employee approval item detail. There are two contextual uses for this endpoint:
|
|
1. The user has the role context of `idn:nesr:read`, in which case they
|
|
can get any approval.
|
|
2. The user owns the requested approval.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
description: Non-Employee approval item id (UUID)
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listNonEmployeeApprovals
|
|
schema:
|
|
type: string
|
|
example: e136567de87e4d029e60b3c3c55db56d
|
|
- in: query
|
|
name: include-detail
|
|
description: The object nonEmployeeRequest will not be included detail when set to false. *Default value is true*
|
|
required: false
|
|
schema:
|
|
type: boolean
|
|
example: true
|
|
responses:
|
|
'200':
|
|
description: Non-Employee approval item object.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/paths/~1non-employee-requests/post/responses/200/content/application~1json/schema/allOf/1/properties/approvalItems/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeApprovalItemBase.yaml
|
|
- type: object
|
|
properties:
|
|
nonEmployeeRequest:
|
|
allOf:
|
|
- $ref: '#/paths/~1non-employee-approvals/get/responses/200/content/application~1json/schema/items/allOf/1/properties/nonEmployeeRequest'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeRequestLite.yaml
|
|
- type: object
|
|
properties:
|
|
accountName:
|
|
type: string
|
|
description: Requested identity account name.
|
|
example: william.smith
|
|
firstName:
|
|
type: string
|
|
description: Non-Employee's first name.
|
|
example: William
|
|
lastName:
|
|
type: string
|
|
description: Non-Employee's last name.
|
|
example: Smith
|
|
email:
|
|
type: string
|
|
description: Non-Employee's email.
|
|
example: william.smith@example.com
|
|
phone:
|
|
type: string
|
|
description: Non-Employee's phone.
|
|
example: '5125555555'
|
|
manager:
|
|
type: string
|
|
description: The account ID of a valid identity to serve as this non-employee's manager.
|
|
example: jane.doe
|
|
nonEmployeeSource:
|
|
allOf:
|
|
- $ref: '#/paths/~1non-employee-requests/post/responses/200/content/application~1json/schema/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeSourceLite.yaml
|
|
- type: object
|
|
properties:
|
|
schemaAttributes:
|
|
description: List of schema attributes associated with this non-employee source.
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1non-employee-sources~1%7BsourceId%7D~1schema-attributes/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeSchemaAttribute.yaml
|
|
data:
|
|
type: object
|
|
additionalProperties:
|
|
type: string
|
|
description: Additional attributes for a non-employee. Up to 10 custom attributes can be added.
|
|
example:
|
|
description: Auditing
|
|
approvalStatus:
|
|
$ref: '#/paths/~1non-employee-requests/post/responses/200/content/application~1json/schema/allOf/1/properties/approvalStatus'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/ApprovalStatus.yaml
|
|
comment:
|
|
type: string
|
|
description: Comment of requester
|
|
example: approved
|
|
completionDate:
|
|
type: string
|
|
format: date-time
|
|
description: When the request was completely approved.
|
|
example: '2020-03-24T11:11:41.139-05:00'
|
|
startDate:
|
|
type: string
|
|
format: date
|
|
description: Non-Employee employment start date.
|
|
example: '2020-03-24'
|
|
endDate:
|
|
type: string
|
|
format: date
|
|
description: Non-Employee employment end date.
|
|
example: '2021-03-25'
|
|
modified:
|
|
type: string
|
|
format: date-time
|
|
description: When the request was last modified.
|
|
example: '2020-03-24T11:11:41.139-05:00'
|
|
created:
|
|
type: string
|
|
format: date-time
|
|
description: When the request was created.
|
|
example: '2020-03-24T11:11:41.139-05:00'
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID)
|
|
$IncludeDetail = $true # Boolean | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional)
|
|
|
|
# Get a non-employee approval item detail
|
|
|
|
try {
|
|
Get-NonEmployeeApproval-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-NonEmployeeApproval -Id $Id -IncludeDetail $IncludeDetail
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeApproval"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/non-employee-approvals/{id}/approve:
|
|
post:
|
|
operationId: approveNonEmployeeRequest
|
|
security:
|
|
- userAuth: []
|
|
tags:
|
|
- Non-Employee Lifecycle Management
|
|
summary: Approve a Non-Employee Request
|
|
description: Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
description: Non-Employee approval item id (UUID)
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listNonEmployeeApprovals
|
|
schema:
|
|
type: string
|
|
example: e136567de87e4d029e60b3c3c55db56d
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
comment:
|
|
type: string
|
|
description: Comment on the approval item.
|
|
maxLength: 4000
|
|
example: Approved by manager
|
|
responses:
|
|
'200':
|
|
description: Non-Employee approval item object.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1non-employee-approvals/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeApprovalItem.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID)
|
|
$NonEmployeeApprovalDecision = @"
|
|
{
|
|
"comment" : "Approved by manager"
|
|
}
|
|
"@
|
|
|
|
# Approve a Non-Employee Request
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision
|
|
Approve-NonEmployeeRequest-Id $Id -NonEmployeeApprovalDecision $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Approve-NonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $NonEmployeeApprovalDecision
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-NonEmployeeRequest"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/non-employee-approvals/{id}/reject:
|
|
post:
|
|
operationId: rejectNonEmployeeRequest
|
|
security:
|
|
- userAuth: []
|
|
tags:
|
|
- Non-Employee Lifecycle Management
|
|
summary: Reject a Non-Employee Request
|
|
description: This endpoint will reject an approval item request and notify user. The current user must be the requested approver.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
description: Non-Employee approval item id (UUID)
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listNonEmployeeApprovals
|
|
schema:
|
|
type: string
|
|
example: e136567de87e4d029e60b3c3c55db56d
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
comment:
|
|
type: string
|
|
description: Comment on the approval item.
|
|
maxLength: 4000
|
|
example: approved
|
|
required:
|
|
- comment
|
|
responses:
|
|
'200':
|
|
description: Non-Employee approval item object.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1non-employee-approvals/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeApprovalItem.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID)
|
|
$NonEmployeeRejectApprovalDecision = @"
|
|
{
|
|
"comment" : "approved"
|
|
}
|
|
"@
|
|
|
|
# Reject a Non-Employee Request
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision
|
|
Deny-NonEmployeeRequest-Id $Id -NonEmployeeRejectApprovalDecision $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Deny-NonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $NonEmployeeRejectApprovalDecision
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-NonEmployeeRequest"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/non-employee-approvals/summary/{requested-for}:
|
|
get:
|
|
operationId: getNonEmployeeApprovalSummary
|
|
security:
|
|
- userAuth: []
|
|
tags:
|
|
- Non-Employee Lifecycle Management
|
|
summary: Get Summary of Non-Employee Approval Requests
|
|
description: |-
|
|
This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter:
|
|
1. The user has the role context of `idn:nesr:read`, in which case he or
|
|
she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver's id.
|
|
2. The current user is an approver, in which case "me" should be provided
|
|
as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her.
|
|
parameters:
|
|
- in: path
|
|
name: requested-for
|
|
schema:
|
|
type: string
|
|
description: The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use "me" instead to indicate the current user.
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listIdentities
|
|
example: 2c91808280430dfb0180431a59440460
|
|
responses:
|
|
'200':
|
|
description: summary of non-employee approval requests
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
approved:
|
|
type: integer
|
|
description: The number of approved non-employee approval requests.
|
|
format: int32
|
|
example: 2
|
|
pending:
|
|
type: integer
|
|
description: The number of pending non-employee approval requests.
|
|
format: int32
|
|
example: 2
|
|
rejected:
|
|
type: integer
|
|
description: The number of rejected non-employee approval requests.
|
|
format: int32
|
|
example: 2
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use ""me"" instead to indicate the current user.
|
|
|
|
# Get Summary of Non-Employee Approval Requests
|
|
|
|
try {
|
|
Get-NonEmployeeApprovalSummary-RequestedFor $RequestedFor
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-NonEmployeeApprovalSummary -RequestedFor $RequestedFor
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeApprovalSummary"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/non-employee-sources/{sourceId}/schema-attributes:
|
|
get:
|
|
operationId: getNonEmployeeSourceSchemaAttributes
|
|
security:
|
|
- userAuth: []
|
|
tags:
|
|
- Non-Employee Lifecycle Management
|
|
summary: List Schema Attributes Non-Employee Source
|
|
description: |-
|
|
This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned.
|
|
Requires role context of `idn:nesr:read` or the user must be an account manager of the source.
|
|
parameters:
|
|
- in: path
|
|
name: sourceId
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listNonEmployeeSources
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
description: The Source id
|
|
responses:
|
|
'200':
|
|
description: A list of Schema Attributes
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: UUID
|
|
example: ac110005-7156-1150-8171-5b292e3e0084
|
|
description: Schema Attribute Id
|
|
system:
|
|
type: boolean
|
|
description: True if this schema attribute is mandatory on all non-employees sources.
|
|
example: true
|
|
default: false
|
|
modified:
|
|
type: string
|
|
format: date-time
|
|
description: When the schema attribute was last modified.
|
|
example: '2019-08-23T18:52:59.162Z'
|
|
created:
|
|
type: string
|
|
format: date-time
|
|
description: When the schema attribute was created.
|
|
example: '2019-08-23T18:40:35.772Z'
|
|
type:
|
|
type: string
|
|
enum:
|
|
- TEXT
|
|
- DATE
|
|
- IDENTITY
|
|
description: Enum representing the type of data a schema attribute accepts.
|
|
example: TEXT
|
|
label:
|
|
type: string
|
|
description: Label displayed on the UI for this schema attribute.
|
|
example: Account Name
|
|
technicalName:
|
|
type: string
|
|
description: The technical name of the attribute. Must be unique per source.
|
|
example: account.name
|
|
helpText:
|
|
type: string
|
|
description: help text displayed by UI.
|
|
example: The unique identifier for the account
|
|
placeholder:
|
|
type: string
|
|
description: Hint text that fills UI box.
|
|
example: Enter a unique user name for this account.
|
|
required:
|
|
type: boolean
|
|
description: If true, the schema attribute is required for all non-employees in the source
|
|
example: true
|
|
default: false
|
|
required:
|
|
- type
|
|
- technicalName
|
|
- label
|
|
maxItems: 18
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id
|
|
|
|
# List Schema Attributes Non-Employee Source
|
|
|
|
try {
|
|
Get-NonEmployeeSourceSchemaAttributes-SourceId $SourceId
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-NonEmployeeSourceSchemaAttributes -SourceId $SourceId
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeSourceSchemaAttributes"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
post:
|
|
operationId: createNonEmployeeSourceSchemaAttributes
|
|
tags:
|
|
- Non-Employee Lifecycle Management
|
|
summary: Create a new Schema Attribute for Non-Employee Source
|
|
description: |-
|
|
This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a "400.1.409 Reference conflict" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a "400.1.4 Limit violation" response.
|
|
Requires role context of `idn:nesr:create`
|
|
parameters:
|
|
- in: path
|
|
name: sourceId
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listNonEmployeeSources
|
|
description: The Source id
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: Type of the attribute. Only type 'TEXT' is supported for custom attributes.
|
|
example: TEXT
|
|
label:
|
|
type: string
|
|
description: Label displayed on the UI for this schema attribute.
|
|
example: Account Name
|
|
technicalName:
|
|
type: string
|
|
description: The technical name of the attribute. Must be unique per source.
|
|
example: account.name
|
|
helpText:
|
|
type: string
|
|
description: help text displayed by UI.
|
|
example: The unique identifier for the account
|
|
placeholder:
|
|
type: string
|
|
description: Hint text that fills UI box.
|
|
example: Enter a unique user name for this account.
|
|
required:
|
|
type: boolean
|
|
description: If true, the schema attribute is required for all non-employees in the source
|
|
example: true
|
|
required:
|
|
- type
|
|
- technicalName
|
|
- label
|
|
responses:
|
|
'200':
|
|
description: Schema Attribute created.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1non-employee-sources~1%7BsourceId%7D~1schema-attributes/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeSchemaAttribute.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id
|
|
$NonEmployeeSchemaAttributeBody = @"
|
|
{
|
|
"helpText" : "The unique identifier for the account",
|
|
"label" : "Account Name",
|
|
"placeholder" : "Enter a unique user name for this account.",
|
|
"type" : "TEXT",
|
|
"technicalName" : "account.name",
|
|
"required" : true
|
|
}
|
|
"@
|
|
|
|
# Create a new Schema Attribute for Non-Employee Source
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody
|
|
New-NonEmployeeSourceSchemaAttributes-SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# New-NonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $NonEmployeeSchemaAttributeBody
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-NonEmployeeSourceSchemaAttributes"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
delete:
|
|
operationId: deleteNonEmployeeSourceSchemaAttributes
|
|
tags:
|
|
- Non-Employee Lifecycle Management
|
|
summary: Delete all custom schema attributes for Non-Employee Source
|
|
description: This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete`
|
|
parameters:
|
|
- in: path
|
|
name: sourceId
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listNonEmployeeSources
|
|
description: The Source id
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
responses:
|
|
'204':
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/204.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id
|
|
|
|
# Delete all custom schema attributes for Non-Employee Source
|
|
|
|
try {
|
|
Remove-NonEmployeeSourceSchemaAttributes-SourceId $SourceId
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Remove-NonEmployeeSourceSchemaAttributes -SourceId $SourceId
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeSourceSchemaAttributes"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/non-employee-sources/{sourceId}/schema-attributes/{attributeId}:
|
|
get:
|
|
operationId: getNonEmployeeSchemaAttribute
|
|
security:
|
|
- userAuth: []
|
|
tags:
|
|
- Non-Employee Lifecycle Management
|
|
summary: Get Schema Attribute Non-Employee Source
|
|
description: This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source.
|
|
parameters:
|
|
- in: path
|
|
name: attributeId
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getNonEmployeeSourceSchemaAttributes
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
description: The Schema Attribute Id (UUID)
|
|
- in: path
|
|
name: sourceId
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listNonEmployeeSources
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
description: The Source id
|
|
responses:
|
|
'200':
|
|
description: The Schema Attribute
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1non-employee-sources~1%7BsourceId%7D~1schema-attributes/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeSchemaAttribute.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID)
|
|
$SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id
|
|
|
|
# Get Schema Attribute Non-Employee Source
|
|
|
|
try {
|
|
Get-NonEmployeeSchemaAttribute-AttributeId $AttributeId -SourceId $SourceId
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeSchemaAttribute"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
patch:
|
|
operationId: patchNonEmployeeSchemaAttribute
|
|
tags:
|
|
- Non-Employee Lifecycle Management
|
|
summary: Patch a Schema Attribute for Non-Employee Source
|
|
description: |
|
|
This end-point patches a specific schema attribute for a non-employee SourceId.
|
|
Requires role context of `idn:nesr:update`
|
|
parameters:
|
|
- in: path
|
|
name: attributeId
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getNonEmployeeSourceSchemaAttributes
|
|
description: The Schema Attribute Id (UUID)
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
- in: path
|
|
name: sourceId
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listNonEmployeeSources
|
|
description: The Source id
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
requestBody:
|
|
description: A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'.
|
|
content:
|
|
application/json-patch+json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/JsonPatchOperation.yaml
|
|
example:
|
|
- op: replace
|
|
path: /label
|
|
value:
|
|
new attribute label: null
|
|
required: true
|
|
responses:
|
|
'200':
|
|
description: The Schema Attribute was successfully patched.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1non-employee-sources~1%7BsourceId%7D~1schema-attributes/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeSchemaAttribute.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID)
|
|
$SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id
|
|
# JsonPatchOperation[] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'.
|
|
$JsonPatchOperation = @"{
|
|
"op" : "replace",
|
|
"path" : "/description",
|
|
"value" : "New description"
|
|
}"@
|
|
|
|
|
|
# Patch a Schema Attribute for Non-Employee Source
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
|
|
Update-NonEmployeeSchemaAttribute-AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Update-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $JsonPatchOperation
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-NonEmployeeSchemaAttribute"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
delete:
|
|
operationId: deleteNonEmployeeSchemaAttribute
|
|
tags:
|
|
- Non-Employee Lifecycle Management
|
|
summary: Delete a Schema Attribute for Non-Employee Source
|
|
description: |
|
|
This end-point deletes a specific schema attribute for a non-employee source.
|
|
Requires role context of `idn:nesr:delete`
|
|
parameters:
|
|
- in: path
|
|
name: attributeId
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getNonEmployeeSourceSchemaAttributes
|
|
description: The Schema Attribute Id (UUID)
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
- in: path
|
|
name: sourceId
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listNonEmployeeSources
|
|
description: The Source id
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
responses:
|
|
'204':
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/204.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID)
|
|
$SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id
|
|
|
|
# Delete a Schema Attribute for Non-Employee Source
|
|
|
|
try {
|
|
Remove-NonEmployeeSchemaAttribute-AttributeId $AttributeId -SourceId $SourceId
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Remove-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeSchemaAttribute"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/oauth-clients:
|
|
get:
|
|
operationId: listOauthClients
|
|
security:
|
|
- userAuth:
|
|
- sp:oauth-client:manage
|
|
tags:
|
|
- OAuth Clients
|
|
summary: List OAuth Clients
|
|
description: This gets a list of OAuth clients.
|
|
parameters:
|
|
- in: query
|
|
name: filters
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: |-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
**lastUsed**: *le, isnull*
|
|
example: lastUsed le 2023-02-05T10:59:27.214Z
|
|
responses:
|
|
'200':
|
|
description: List of OAuth clients.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: ID of the OAuth client
|
|
example: 2c9180835d2e5168015d32f890ca1581
|
|
businessName:
|
|
type: string
|
|
nullable: true
|
|
description: The name of the business the API Client should belong to
|
|
example: Acme-Solar
|
|
homepageUrl:
|
|
type: string
|
|
nullable: true
|
|
description: The homepage URL associated with the owner of the API Client
|
|
example: http://localhost:12345
|
|
name:
|
|
type: string
|
|
description: A human-readable name for the API Client
|
|
example: Demo API Client
|
|
description:
|
|
type: string
|
|
nullable: true
|
|
description: A description of the API Client
|
|
example: An API client used for the authorization_code, refresh_token, and client_credentials flows
|
|
accessTokenValiditySeconds:
|
|
type: integer
|
|
format: int32
|
|
description: The number of seconds an access token generated for this API Client is valid for
|
|
example: 750
|
|
refreshTokenValiditySeconds:
|
|
type: integer
|
|
format: int32
|
|
description: The number of seconds a refresh token generated for this API Client is valid for
|
|
example: 86400
|
|
redirectUris:
|
|
type: array
|
|
nullable: true
|
|
items:
|
|
type: string
|
|
description: A list of the approved redirect URIs used with the authorization_code flow
|
|
example:
|
|
- http://localhost:12345
|
|
grantTypes:
|
|
type: array
|
|
items:
|
|
description: OAuth2 Grant Type
|
|
type: string
|
|
example: CLIENT_CREDENTIALS
|
|
enum:
|
|
- CLIENT_CREDENTIALS
|
|
- AUTHORIZATION_CODE
|
|
- REFRESH_TOKEN
|
|
description: A list of OAuth 2.0 grant types this API Client can be used with
|
|
example:
|
|
- AUTHORIZATION_CODE
|
|
- CLIENT_CREDENTIALS
|
|
- REFRESH_TOKEN
|
|
accessType:
|
|
type: string
|
|
enum:
|
|
- ONLINE
|
|
- OFFLINE
|
|
description: Access type of API Client indicating online or offline use
|
|
example: OFFLINE
|
|
type:
|
|
type: string
|
|
enum:
|
|
- CONFIDENTIAL
|
|
- PUBLIC
|
|
description: Type of an API Client indicating public or confidentials use
|
|
example: CONFIDENTIAL
|
|
internal:
|
|
type: boolean
|
|
description: An indicator of whether the API Client can be used for requests internal to IDN
|
|
example: false
|
|
enabled:
|
|
type: boolean
|
|
description: An indicator of whether the API Client is enabled for use
|
|
example: true
|
|
strongAuthSupported:
|
|
type: boolean
|
|
description: An indicator of whether the API Client supports strong authentication
|
|
example: false
|
|
claimsSupported:
|
|
type: boolean
|
|
description: An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow
|
|
example: false
|
|
created:
|
|
type: string
|
|
format: date-time
|
|
description: The date and time, down to the millisecond, when the API Client was created
|
|
example: '2017-07-11T18:45:37.098Z'
|
|
modified:
|
|
type: string
|
|
format: date-time
|
|
description: The date and time, down to the millisecond, when the API Client was last updated
|
|
example: '2018-06-25T20:22:28.104Z'
|
|
secret:
|
|
type: string
|
|
nullable: true
|
|
metadata:
|
|
type: string
|
|
nullable: true
|
|
lastUsed:
|
|
type: string
|
|
nullable: true
|
|
format: date-time
|
|
description: The date and time, down to the millisecond, when this API Client was last used to generate an access token. This timestamp does not get updated on every API Client usage, but only once a day. This property can be useful for identifying which API Clients are no longer actively used and can be removed.
|
|
example: '2017-07-11T18:45:37.098Z'
|
|
scope:
|
|
type: array
|
|
nullable: true
|
|
items:
|
|
type: string
|
|
default: sp:scopes:all
|
|
description: Scopes of the API Client.
|
|
example:
|
|
- demo:api-client-scope:first
|
|
- demo:api-client-scope:second
|
|
required:
|
|
- id
|
|
- businessName
|
|
- homepageUrl
|
|
- name
|
|
- description
|
|
- accessTokenValiditySeconds
|
|
- refreshTokenValiditySeconds
|
|
- redirectUris
|
|
- grantTypes
|
|
- accessType
|
|
- type
|
|
- internal
|
|
- enabled
|
|
- strongAuthSupported
|
|
- claimsSupported
|
|
- created
|
|
- modified
|
|
- scope
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Filters = "lastUsed le 2023-02-05T10:59:27.214Z" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional)
|
|
|
|
# List OAuth Clients
|
|
|
|
try {
|
|
Get-OauthClients
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-OauthClients -Filters $Filters
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-OauthClients"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
post:
|
|
operationId: createOauthClient
|
|
security:
|
|
- userAuth:
|
|
- sp:oauth-client:manage
|
|
tags:
|
|
- OAuth Clients
|
|
summary: Create OAuth Client
|
|
description: This creates an OAuth client.
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
businessName:
|
|
type: string
|
|
nullable: true
|
|
description: The name of the business the API Client should belong to
|
|
example: Acme-Solar
|
|
homepageUrl:
|
|
type: string
|
|
nullable: true
|
|
description: The homepage URL associated with the owner of the API Client
|
|
example: http://localhost:12345
|
|
name:
|
|
type: string
|
|
nullable: true
|
|
description: A human-readable name for the API Client
|
|
example: Demo API Client
|
|
description:
|
|
type: string
|
|
nullable: true
|
|
description: A description of the API Client
|
|
example: An API client used for the authorization_code, refresh_token, and client_credentials flows
|
|
accessTokenValiditySeconds:
|
|
description: The number of seconds an access token generated for this API Client is valid for
|
|
type: integer
|
|
format: int32
|
|
example: 750
|
|
refreshTokenValiditySeconds:
|
|
description: The number of seconds a refresh token generated for this API Client is valid for
|
|
example: 86400
|
|
type: integer
|
|
format: int32
|
|
redirectUris:
|
|
type: array
|
|
nullable: true
|
|
items:
|
|
type: string
|
|
description: A list of the approved redirect URIs. Provide one or more URIs when assigning the AUTHORIZATION_CODE grant type to a new OAuth Client.
|
|
example:
|
|
- http://localhost:12345
|
|
grantTypes:
|
|
type: array
|
|
nullable: true
|
|
items:
|
|
$ref: '#/paths/~1oauth-clients/get/responses/200/content/application~1json/schema/items/properties/grantTypes/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/GrantType.yaml
|
|
description: A list of OAuth 2.0 grant types this API Client can be used with
|
|
example:
|
|
- AUTHORIZATION_CODE
|
|
- CLIENT_CREDENTIALS
|
|
- REFRESH_TOKEN
|
|
accessType:
|
|
$ref: '#/paths/~1oauth-clients/get/responses/200/content/application~1json/schema/items/properties/accessType'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/AccessType.yaml
|
|
type:
|
|
$ref: '#/paths/~1oauth-clients/get/responses/200/content/application~1json/schema/items/properties/type'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ClientType.yaml
|
|
internal:
|
|
type: boolean
|
|
description: An indicator of whether the API Client can be used for requests internal within the product.
|
|
example: false
|
|
enabled:
|
|
type: boolean
|
|
description: An indicator of whether the API Client is enabled for use
|
|
example: true
|
|
strongAuthSupported:
|
|
type: boolean
|
|
description: An indicator of whether the API Client supports strong authentication
|
|
example: false
|
|
claimsSupported:
|
|
type: boolean
|
|
description: An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow
|
|
example: false
|
|
scope:
|
|
type: array
|
|
nullable: true
|
|
items:
|
|
type: string
|
|
default: sp:scopes:all
|
|
description: Scopes of the API Client. If no scope is specified, the client will be created with the default scope "sp:scopes:all". This means the API Client will have all the rights of the owner who created it.
|
|
example:
|
|
- demo:api-client-scope:first
|
|
- demo:api-client-scope:second
|
|
required:
|
|
- name
|
|
- description
|
|
- accessTokenValiditySeconds
|
|
- grantTypes
|
|
- accessType
|
|
- enabled
|
|
responses:
|
|
'200':
|
|
description: Request succeeded.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: ID of the OAuth client
|
|
example: 2c9180835d2e5168015d32f890ca1581
|
|
secret:
|
|
type: string
|
|
description: Secret of the OAuth client (This field is only returned on the intial create call.)
|
|
example: 5c32dd9b21adb51c77794d46e71de117a1d0ddb36a7ff941fa28014ab7de2cf3
|
|
businessName:
|
|
type: string
|
|
description: The name of the business the API Client should belong to
|
|
example: Acme-Solar
|
|
homepageUrl:
|
|
type: string
|
|
description: The homepage URL associated with the owner of the API Client
|
|
example: http://localhost:12345
|
|
name:
|
|
type: string
|
|
description: A human-readable name for the API Client
|
|
example: Demo API Client
|
|
description:
|
|
type: string
|
|
description: A description of the API Client
|
|
example: An API client used for the authorization_code, refresh_token, and client_credentials flows
|
|
accessTokenValiditySeconds:
|
|
description: The number of seconds an access token generated for this API Client is valid for
|
|
example: 750
|
|
type: integer
|
|
format: int32
|
|
refreshTokenValiditySeconds:
|
|
description: The number of seconds a refresh token generated for this API Client is valid for
|
|
example: 86400
|
|
type: integer
|
|
format: int32
|
|
redirectUris:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: A list of the approved redirect URIs used with the authorization_code flow
|
|
example:
|
|
- http://localhost:12345
|
|
grantTypes:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1oauth-clients/get/responses/200/content/application~1json/schema/items/properties/grantTypes/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/GrantType.yaml
|
|
description: A list of OAuth 2.0 grant types this API Client can be used with
|
|
example:
|
|
- AUTHORIZATION_CODE
|
|
- CLIENT_CREDENTIALS
|
|
- REFRESH_TOKEN
|
|
accessType:
|
|
$ref: '#/paths/~1oauth-clients/get/responses/200/content/application~1json/schema/items/properties/accessType'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/AccessType.yaml
|
|
type:
|
|
$ref: '#/paths/~1oauth-clients/get/responses/200/content/application~1json/schema/items/properties/type'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ClientType.yaml
|
|
internal:
|
|
type: boolean
|
|
description: An indicator of whether the API Client can be used for requests internal to IDN
|
|
example: false
|
|
enabled:
|
|
type: boolean
|
|
description: An indicator of whether the API Client is enabled for use
|
|
example: true
|
|
strongAuthSupported:
|
|
type: boolean
|
|
description: An indicator of whether the API Client supports strong authentication
|
|
example: false
|
|
claimsSupported:
|
|
type: boolean
|
|
description: An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow
|
|
example: false
|
|
created:
|
|
type: string
|
|
format: date-time
|
|
description: The date and time, down to the millisecond, when the API Client was created
|
|
example: '2017-07-11T18:45:37.098Z'
|
|
modified:
|
|
type: string
|
|
format: date-time
|
|
description: The date and time, down to the millisecond, when the API Client was last updated
|
|
example: '2018-06-25T20:22:28.104Z'
|
|
scope:
|
|
type: array
|
|
nullable: true
|
|
items:
|
|
type: string
|
|
default: sp:scopes:all
|
|
description: Scopes of the API Client.
|
|
example:
|
|
- demo:api-client-scope:first
|
|
- demo:api-client-scope:second
|
|
required:
|
|
- id
|
|
- secret
|
|
- businessName
|
|
- homepageUrl
|
|
- name
|
|
- description
|
|
- accessTokenValiditySeconds
|
|
- refreshTokenValiditySeconds
|
|
- redirectUris
|
|
- grantTypes
|
|
- accessType
|
|
- type
|
|
- internal
|
|
- enabled
|
|
- strongAuthSupported
|
|
- claimsSupported
|
|
- created
|
|
- modified
|
|
- scope
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$CreateOAuthClientRequest = @"
|
|
{
|
|
"internal" : false,
|
|
"businessName" : "Acme-Solar",
|
|
"description" : "An API client used for the authorization_code, refresh_token, and client_credentials flows",
|
|
"refreshTokenValiditySeconds" : 86400,
|
|
"type" : "CONFIDENTIAL",
|
|
"redirectUris" : [ "http://localhost:12345" ],
|
|
"enabled" : true,
|
|
"accessType" : "OFFLINE",
|
|
"grantTypes" : [ "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "REFRESH_TOKEN" ],
|
|
"strongAuthSupported" : false,
|
|
"homepageUrl" : "http://localhost:12345",
|
|
"accessTokenValiditySeconds" : 750,
|
|
"scope" : [ "demo:api-client-scope:first", "demo:api-client-scope:second" ],
|
|
"name" : "Demo API Client",
|
|
"claimsSupported" : false
|
|
}
|
|
"@
|
|
|
|
# Create OAuth Client
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToCreateOAuthClientRequest -Json $CreateOAuthClientRequest
|
|
New-OauthClient-CreateOAuthClientRequest $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# New-OauthClient -CreateOAuthClientRequest $CreateOAuthClientRequest
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-OauthClient"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/oauth-clients/{id}:
|
|
get:
|
|
operationId: getOauthClient
|
|
security:
|
|
- userAuth:
|
|
- sp:oauth-client:manage
|
|
- sp:oauth-client:read
|
|
tags:
|
|
- OAuth Clients
|
|
summary: Get OAuth Client
|
|
description: This gets details of an OAuth client.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listOauthClients
|
|
description: The OAuth client id
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
responses:
|
|
'200':
|
|
description: Request succeeded.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1oauth-clients/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/GetOAuthClientResponse.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id
|
|
|
|
# Get OAuth Client
|
|
|
|
try {
|
|
Get-OauthClient-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-OauthClient -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-OauthClient"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
delete:
|
|
operationId: deleteOauthClient
|
|
security:
|
|
- userAuth:
|
|
- sp:oauth-client:manage
|
|
tags:
|
|
- OAuth Clients
|
|
summary: Delete OAuth Client
|
|
description: This deletes an OAuth client.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listOauthClients
|
|
description: The OAuth client id
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
responses:
|
|
'204':
|
|
description: No content.
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id
|
|
|
|
# Delete OAuth Client
|
|
|
|
try {
|
|
Remove-OauthClient-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Remove-OauthClient -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-OauthClient"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
patch:
|
|
operationId: patchOauthClient
|
|
security:
|
|
- userAuth:
|
|
- sp:oauth-client:manage
|
|
tags:
|
|
- OAuth Clients
|
|
summary: Patch OAuth Client
|
|
description: This performs a targeted update to the field(s) of an OAuth client.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listOauthClients
|
|
description: The OAuth client id
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
requestBody:
|
|
required: true
|
|
description: |
|
|
A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
|
|
The following fields are patchable:
|
|
* tenant
|
|
* businessName
|
|
* homepageUrl
|
|
* name
|
|
* description
|
|
* accessTokenValiditySeconds
|
|
* refreshTokenValiditySeconds
|
|
* redirectUris
|
|
* grantTypes
|
|
* accessType
|
|
* enabled
|
|
* strongAuthSupported
|
|
* claimsSupported
|
|
content:
|
|
application/json-patch+json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/JsonPatchOperation.yaml
|
|
example:
|
|
- op: replace
|
|
path: /strongAuthSupported
|
|
value: true
|
|
- op: replace
|
|
path: /businessName
|
|
value: acme-solar
|
|
responses:
|
|
'200':
|
|
description: Indicates the PATCH operation succeeded, and returns the OAuth client's new representation.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1oauth-clients/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/GetOAuthClientResponse.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id
|
|
# JsonPatchOperation[] | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported
|
|
$JsonPatchOperation = @"{
|
|
"op" : "replace",
|
|
"path" : "/description",
|
|
"value" : "New description"
|
|
}"@
|
|
|
|
|
|
# Patch OAuth Client
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
|
|
Update-OauthClient-Id $Id -JsonPatchOperation $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Update-OauthClient -Id $Id -JsonPatchOperation $JsonPatchOperation
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-OauthClient"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/password-sync-groups:
|
|
get:
|
|
operationId: getPasswordSyncGroups
|
|
tags:
|
|
- Password Sync Groups
|
|
summary: Get Password Sync Group List
|
|
description: This API returns a list of password sync groups.
|
|
security:
|
|
- userAuth:
|
|
- idn:password-sync-group-management:read
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
parameters:
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
responses:
|
|
'200':
|
|
description: A list of password sync groups.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: ID of the sync group
|
|
example: 6881f631-3bd5-4213-9c75-8e05cc3e35dd
|
|
name:
|
|
description: Name of the sync group
|
|
type: string
|
|
example: Password Sync Group 1
|
|
passwordPolicyId:
|
|
type: string
|
|
description: ID of the password policy
|
|
example: 2c91808d744ba0ce01746f93b6204501
|
|
sourceIds:
|
|
type: array
|
|
description: List of password managed sources IDs
|
|
items:
|
|
type: string
|
|
example:
|
|
- 2c918084660f45d6016617daa9210584
|
|
- 2c918084660f45d6016617daa9210500
|
|
created:
|
|
type: string
|
|
description: The date and time this sync group was created
|
|
format: date-time
|
|
example: '2023-03-16T04:00:00Z'
|
|
nullable: true
|
|
modified:
|
|
type: string
|
|
description: The date and time this sync group was last modified
|
|
format: date-time
|
|
example: '2023-03-16T04:00:00Z'
|
|
nullable: true
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
|
|
# Get Password Sync Group List
|
|
|
|
try {
|
|
Get-PasswordSyncGroups
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-PasswordSyncGroups -Limit $Limit -Offset $Offset -Count $Count
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordSyncGroups"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
post:
|
|
operationId: createPasswordSyncGroup
|
|
tags:
|
|
- Password Sync Groups
|
|
summary: Create Password Sync Group
|
|
description: This API creates a password sync group based on the specifications provided.
|
|
security:
|
|
- userAuth:
|
|
- idn:password-sync-group-management:write
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1password-sync-groups/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/PasswordSyncGroup.yaml
|
|
example:
|
|
name: Password Sync Group 2
|
|
passwordPolicyId: 2c91808d744ba0ce01746f93b6204501
|
|
sourceIds:
|
|
- 2c918084660f45d6016617daa9210584
|
|
- 2c918084660f45d6016617daa9210500
|
|
responses:
|
|
'200':
|
|
description: Reference to the password sync group.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1password-sync-groups/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/PasswordSyncGroup.yaml
|
|
example:
|
|
id: 6881f631-3bd5-4213-9c75-8e05cc3e35dd
|
|
name: Password Sync Group 2
|
|
passwordPolicyId: 2c91808d744ba0ce01746f93b6204501
|
|
sourceIds:
|
|
- 2c918084660f45d6016617daa9210584
|
|
- 2c918084660f45d6016617daa9210500
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$PasswordSyncGroup = @"
|
|
{
|
|
"created" : "2023-03-16T04:00:00Z",
|
|
"name" : "Password Sync Group 1",
|
|
"modified" : "2023-03-16T04:00:00Z",
|
|
"passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501",
|
|
"id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd",
|
|
"sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ]
|
|
}
|
|
"@
|
|
|
|
# Create Password Sync Group
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup
|
|
New-PasswordSyncGroup-PasswordSyncGroup $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# New-PasswordSyncGroup -PasswordSyncGroup $PasswordSyncGroup
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-PasswordSyncGroup"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/password-sync-groups/{id}:
|
|
get:
|
|
operationId: getPasswordSyncGroup
|
|
tags:
|
|
- Password Sync Groups
|
|
summary: Get Password Sync Group by ID
|
|
description: This API returns the sync group for the specified ID.
|
|
security:
|
|
- userAuth:
|
|
- idn:password-sync-group-management:read
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getPasswordSyncGroups
|
|
description: The ID of password sync group to retrieve.
|
|
example: 6881f631-3bd5-4213-9c75-8e05cc3e35dd
|
|
responses:
|
|
'200':
|
|
description: Reference to the password sync group.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1password-sync-groups/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/PasswordSyncGroup.yaml
|
|
example:
|
|
id: 6881f631-3bd5-4213-9c75-8e05cc3e35dd
|
|
name: Password Sync Group 1
|
|
passwordPolicyId: 2c91808d744ba0ce01746f93b6204501
|
|
sourceIds:
|
|
- 2c918084660f45d6016617daa9210584
|
|
- 2c918084660f45d6016617daa9210500
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to retrieve.
|
|
|
|
# Get Password Sync Group by ID
|
|
|
|
try {
|
|
Get-PasswordSyncGroup-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-PasswordSyncGroup -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordSyncGroup"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
put:
|
|
operationId: updatePasswordSyncGroup
|
|
tags:
|
|
- Password Sync Groups
|
|
summary: Update Password Sync Group by ID
|
|
description: This API updates the specified password sync group.
|
|
security:
|
|
- userAuth:
|
|
- idn:password-sync-group-management:write
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getPasswordSyncGroups
|
|
description: The ID of password sync group to update.
|
|
example: 6881f631-3bd5-4213-9c75-8e05cc3e35dd
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1password-sync-groups/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/PasswordSyncGroup.yaml
|
|
example:
|
|
id: 6881f631-3bd5-4213-9c75-8e05cc3e35dd
|
|
name: Password Sync Group 2
|
|
passwordPolicyId: 2c91808d744ba0ce01746f93b6204501
|
|
sourceIds:
|
|
- 2c918084660f45d6016617daa9210584
|
|
- 2c918084660f45d6016617daa9210500
|
|
responses:
|
|
'200':
|
|
description: Reference to the password sync group.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1password-sync-groups/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/PasswordSyncGroup.yaml
|
|
example:
|
|
id: 6881f631-3bd5-4213-9c75-8e05cc3e35dd
|
|
name: Password Sync Group 2
|
|
passwordPolicyId: 2c91808d744ba0ce01746f93b6204501
|
|
sourceIds:
|
|
- 2c918084660f45d6016617daa9210584
|
|
- 2c918084660f45d6016617daa9210500
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to update.
|
|
$PasswordSyncGroup = @"
|
|
{
|
|
"created" : "2023-03-16T04:00:00Z",
|
|
"name" : "Password Sync Group 1",
|
|
"modified" : "2023-03-16T04:00:00Z",
|
|
"passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501",
|
|
"id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd",
|
|
"sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ]
|
|
}
|
|
"@
|
|
|
|
# Update Password Sync Group by ID
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup
|
|
Update-PasswordSyncGroup-Id $Id -PasswordSyncGroup $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Update-PasswordSyncGroup -Id $Id -PasswordSyncGroup $PasswordSyncGroup
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-PasswordSyncGroup"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
delete:
|
|
operationId: deletePasswordSyncGroup
|
|
tags:
|
|
- Password Sync Groups
|
|
summary: Delete Password Sync Group by ID
|
|
description: This API deletes the specified password sync group.
|
|
security:
|
|
- userAuth:
|
|
- idn:password-sync-group-management:write
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getPasswordSyncGroups
|
|
description: The ID of password sync group to delete.
|
|
example: 6881f631-3bd5-4213-9c75-8e05cc3e35dd
|
|
responses:
|
|
'204':
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/204.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to delete.
|
|
|
|
# Delete Password Sync Group by ID
|
|
|
|
try {
|
|
Remove-PasswordSyncGroup-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Remove-PasswordSyncGroup -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-PasswordSyncGroup"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/password-policies/{id}:
|
|
get:
|
|
operationId: getPasswordPolicyById
|
|
tags:
|
|
- Password Policies
|
|
summary: Get Password Policy by ID
|
|
description: This API returns the password policy for the specified ID.
|
|
security:
|
|
- userAuth:
|
|
- idn:password-policy:read
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listPasswordPolicies
|
|
description: The ID of password policy to retrieve.
|
|
example: ff808081838d9e9d01838da6a03e0005
|
|
responses:
|
|
'200':
|
|
description: Reference to the password policy.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The password policy Id.
|
|
example: 2c91808e7d976f3b017d9f5ceae440c8
|
|
description:
|
|
type: string
|
|
nullable: true
|
|
description: Description for current password policy.
|
|
example: Information about the Password Policy
|
|
name:
|
|
type: string
|
|
description: The name of the password policy.
|
|
example: PasswordPolicy Example
|
|
dateCreated:
|
|
type: string
|
|
format: date-time
|
|
description: Date the Password Policy was created.
|
|
example: 1639056206564
|
|
lastUpdated:
|
|
type: string
|
|
nullable: true
|
|
format: date-time
|
|
description: Date the Password Policy was updated.
|
|
example: 1939056206564
|
|
firstExpirationReminder:
|
|
type: integer
|
|
format: int64
|
|
description: The number of days before expiration remaninder.
|
|
example: 45
|
|
accountIdMinWordLength:
|
|
type: integer
|
|
format: int64
|
|
description: The minimun length of account Id. By default is equals to -1.
|
|
example: 4
|
|
accountNameMinWordLength:
|
|
type: integer
|
|
format: int64
|
|
description: The minimun length of account name. By default is equals to -1.
|
|
example: 6
|
|
minAlpha:
|
|
type: integer
|
|
format: int64
|
|
description: Maximum alpha. By default is equals to 0.
|
|
example: 5
|
|
minCharacterTypes:
|
|
type: integer
|
|
format: int64
|
|
description: MinCharacterTypes. By default is equals to -1.
|
|
example: 5
|
|
maxLength:
|
|
type: integer
|
|
format: int64
|
|
description: Maximum length of the password.
|
|
example: 25
|
|
minLength:
|
|
type: integer
|
|
format: int64
|
|
description: Minimum length of the password. By default is equals to 0.
|
|
example: 8
|
|
maxRepeatedChars:
|
|
type: integer
|
|
format: int64
|
|
description: Maximum repetition of the same character in the password. By default is equals to -1.
|
|
example: 3
|
|
minLower:
|
|
type: integer
|
|
format: int64
|
|
description: Minimum amount of lower case character in the password. By default is equals to 0.
|
|
example: 8
|
|
minNumeric:
|
|
type: integer
|
|
format: int64
|
|
description: Minimum amount of numeric characters in the password. By default is equals to 0.
|
|
example: 8
|
|
minSpecial:
|
|
type: integer
|
|
format: int64
|
|
description: Minimum amount of special symbols in the password. By default is equals to 0.
|
|
example: 8
|
|
minUpper:
|
|
type: integer
|
|
format: int64
|
|
description: Minimum amount of upper case symbols in the password. By default is equals to 0.
|
|
example: 8
|
|
passwordExpiration:
|
|
type: integer
|
|
format: int64
|
|
description: Number of days before current password expires. By default is equals to 90.
|
|
example: 8
|
|
defaultPolicy:
|
|
type: boolean
|
|
description: Defines whether this policy is default or not. Default policy is created automatically when an org is setup. This field is false by default.
|
|
example: true
|
|
default: false
|
|
enablePasswdExpiration:
|
|
type: boolean
|
|
description: Defines whether this policy is enabled to expire or not. This field is false by default.
|
|
example: true
|
|
default: false
|
|
requireStrongAuthn:
|
|
type: boolean
|
|
description: Defines whether this policy require strong Auth or not. This field is false by default.
|
|
example: true
|
|
default: false
|
|
requireStrongAuthOffNetwork:
|
|
type: boolean
|
|
description: Defines whether this policy require strong Auth of network or not. This field is false by default.
|
|
example: true
|
|
default: false
|
|
requireStrongAuthUntrustedGeographies:
|
|
type: boolean
|
|
description: Defines whether this policy require strong Auth for untrusted geographies. This field is false by default.
|
|
example: true
|
|
default: false
|
|
useAccountAttributes:
|
|
type: boolean
|
|
description: Defines whether this policy uses account attributes or not. This field is false by default.
|
|
example: false
|
|
default: false
|
|
useDictionary:
|
|
type: boolean
|
|
description: Defines whether this policy uses dictionary or not. This field is false by default.
|
|
example: false
|
|
default: false
|
|
useIdentityAttributes:
|
|
type: boolean
|
|
description: Defines whether this policy uses identity attributes or not. This field is false by default.
|
|
example: false
|
|
default: false
|
|
validateAgainstAccountId:
|
|
type: boolean
|
|
description: Defines whether this policy validate against account id or not. This field is false by default.
|
|
example: false
|
|
default: false
|
|
validateAgainstAccountName:
|
|
type: boolean
|
|
description: Defines whether this policy validate against account name or not. This field is false by default.
|
|
example: true
|
|
default: false
|
|
created:
|
|
type: string
|
|
nullable: true
|
|
modified:
|
|
type: string
|
|
nullable: true
|
|
sourceIds:
|
|
type: array
|
|
description: List of sources IDs managed by this password policy.
|
|
items:
|
|
type: string
|
|
example:
|
|
- 2c91808382ffee0b01830de154f14034
|
|
- 2f98808382ffee0b01830de154f12134
|
|
example:
|
|
description: Default Password Policy
|
|
id: 2c91808e7d976f3b017d9f5ceae440c8
|
|
name: Example PP
|
|
dateCreated: 1639056206564
|
|
lastUpdated: 1662385430753
|
|
firstExpirationReminder: 90
|
|
accountIdMinWordLength: 3
|
|
accountNameMinWordLength: 3
|
|
maxLength: 0
|
|
maxRepeatedChars: 4
|
|
minAlpha: 1
|
|
minCharacterTypes: -1
|
|
minLength: 8
|
|
minLower: 0
|
|
minNumeric: 1
|
|
minSpecial: 0
|
|
minUpper: 0
|
|
passwordExpiration: 90
|
|
defaultPolicy: true
|
|
enablePasswdExpiration: false
|
|
requireStrongAuthn: false
|
|
requireStrongAuthOffNetwork: false
|
|
requireStrongAuthUntrustedGeographies: false
|
|
useAccountAttributes: false
|
|
useDictionary: false
|
|
useIdentityAttributes: false
|
|
validateAgainstAccountId: true
|
|
validateAgainstAccountName: true
|
|
sourceIds:
|
|
- 2c91808382ffee0b01830de154f14034
|
|
- 2c91808582ffee0c01830de36511405f
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to retrieve.
|
|
|
|
# Get Password Policy by ID
|
|
|
|
try {
|
|
Get-PasswordPolicyById-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-PasswordPolicyById -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordPolicyById"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
put:
|
|
operationId: setPasswordPolicy
|
|
tags:
|
|
- Password Policies
|
|
summary: Update Password Policy by ID
|
|
description: This API updates the specified password policy.
|
|
security:
|
|
- userAuth:
|
|
- idn:password-policy:write
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listPasswordPolicies
|
|
description: The ID of password policy to update.
|
|
example: ff808081838d9e9d01838da6a03e0007
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1password-policies~1%7Bid%7D/get/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/PasswordPolicyV3Dto.yaml
|
|
example:
|
|
description: Password Policy after update.
|
|
id: 2c91808e7d976f3b017d9f5ceae440c8
|
|
name: Improved Password Policy
|
|
dateCreated: 1639056206564
|
|
lastUpdated: 1662385430753
|
|
firstExpirationReminder: 90
|
|
accountIdMinWordLength: 3
|
|
accountNameMinWordLength: 3
|
|
maxLength: 0
|
|
maxRepeatedChars: 4
|
|
minAlpha: 1
|
|
minCharacterTypes: -1
|
|
minLength: 8
|
|
minLower: 0
|
|
minNumeric: 1
|
|
minSpecial: 0
|
|
minUpper: 0
|
|
passwordExpiration: 90
|
|
defaultPolicy: false
|
|
enablePasswdExpiration: false
|
|
requireStrongAuthn: false
|
|
requireStrongAuthOffNetwork: false
|
|
requireStrongAuthUntrustedGeographies: false
|
|
useAccountAttributes: false
|
|
useDictionary: false
|
|
useIdentityAttributes: false
|
|
validateAgainstAccountId: true
|
|
validateAgainstAccountName: true
|
|
sourceIds:
|
|
- 2c91808382ffee0b01830de154f14034
|
|
- 2c91808582ffee0c01830de36511405f
|
|
responses:
|
|
'200':
|
|
description: Reference to the password policy.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1password-policies~1%7Bid%7D/get/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/PasswordPolicyV3Dto.yaml
|
|
example:
|
|
description: Password Policy after update.
|
|
id: 2c91808e7d976f3b017d9f5ceae440c8
|
|
name: Improved Password Policy
|
|
dateCreated: 1639056206564
|
|
lastUpdated: 1662385430753
|
|
firstExpirationReminder: 90
|
|
accountIdMinWordLength: 3
|
|
accountNameMinWordLength: 3
|
|
maxLength: 0
|
|
maxRepeatedChars: 4
|
|
minAlpha: 1
|
|
minCharacterTypes: -1
|
|
minLength: 8
|
|
minLower: 0
|
|
minNumeric: 1
|
|
minSpecial: 0
|
|
minUpper: 0
|
|
passwordExpiration: 90
|
|
defaultPolicy: false
|
|
enablePasswdExpiration: false
|
|
requireStrongAuthn: false
|
|
requireStrongAuthOffNetwork: false
|
|
requireStrongAuthUntrustedGeographies: false
|
|
useAccountAttributes: false
|
|
useDictionary: false
|
|
useIdentityAttributes: false
|
|
validateAgainstAccountId: true
|
|
validateAgainstAccountName: true
|
|
sourceIds:
|
|
- 2c91808382ffee0b01830de154f14034
|
|
- 2c91808582ffee0c01830de36511405f
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ff808081838d9e9d01838da6a03e0007" # String | The ID of password policy to update.
|
|
$PasswordPolicyV3Dto = @"
|
|
{
|
|
"validateAgainstAccountName" : true,
|
|
"minLength" : 8,
|
|
"description" : "Information about the Password Policy",
|
|
"requireStrongAuthUntrustedGeographies" : true,
|
|
"enablePasswdExpiration" : true,
|
|
"minNumeric" : 8,
|
|
"lastUpdated" : "2000-01-23T04:56:07.000+00:00",
|
|
"validateAgainstAccountId" : false,
|
|
"dateCreated" : "2000-01-23T04:56:07.000+00:00",
|
|
"accountNameMinWordLength" : 6,
|
|
"minUpper" : 8,
|
|
"firstExpirationReminder" : 45,
|
|
"modified" : "modified",
|
|
"id" : "2c91808e7d976f3b017d9f5ceae440c8",
|
|
"requireStrongAuthn" : true,
|
|
"useDictionary" : false,
|
|
"minSpecial" : 8,
|
|
"sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ],
|
|
"passwordExpiration" : 8,
|
|
"maxRepeatedChars" : 3,
|
|
"minCharacterTypes" : 5,
|
|
"minAlpha" : 5,
|
|
"created" : "created",
|
|
"useAccountAttributes" : false,
|
|
"accountIdMinWordLength" : 4,
|
|
"minLower" : 8,
|
|
"useIdentityAttributes" : false,
|
|
"defaultPolicy" : true,
|
|
"requireStrongAuthOffNetwork" : true,
|
|
"name" : "PasswordPolicy Example",
|
|
"maxLength" : 25
|
|
}
|
|
"@
|
|
|
|
# Update Password Policy by ID
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto
|
|
Set-PasswordPolicy-Id $Id -PasswordPolicyV3Dto $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Set-PasswordPolicy -Id $Id -PasswordPolicyV3Dto $PasswordPolicyV3Dto
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-PasswordPolicy"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
delete:
|
|
operationId: deletePasswordPolicy
|
|
tags:
|
|
- Password Policies
|
|
summary: Delete Password Policy by ID
|
|
description: This API deletes the specified password policy.
|
|
security:
|
|
- userAuth:
|
|
- idn:password-policy:write
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listPasswordPolicies
|
|
description: The ID of password policy to delete.
|
|
example: ff808081838d9e9d01838da6a03e0002
|
|
responses:
|
|
'204':
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/204.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to delete.
|
|
|
|
# Delete Password Policy by ID
|
|
|
|
try {
|
|
Remove-PasswordPolicy-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Remove-PasswordPolicy -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-PasswordPolicy"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/password-policies:
|
|
post:
|
|
operationId: createPasswordPolicy
|
|
tags:
|
|
- Password Policies
|
|
summary: Create Password Policy
|
|
description: This API creates the specified password policy.
|
|
security:
|
|
- userAuth:
|
|
- idn:password-policy:write
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1password-policies~1%7Bid%7D/get/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/PasswordPolicyV3Dto.yaml
|
|
example:
|
|
description: New Password Policy with high requirements to password complexity.
|
|
id: null
|
|
name: High security Password Policy
|
|
dateCreated: 1639056206564
|
|
lastUpdated: 1662385430753
|
|
firstExpirationReminder: 90
|
|
accountIdMinWordLength: 3
|
|
accountNameMinWordLength: 3
|
|
maxLength: 0
|
|
maxRepeatedChars: 4
|
|
minAlpha: 1
|
|
minCharacterTypes: -1
|
|
minLength: 8
|
|
minLower: 0
|
|
minNumeric: 1
|
|
minSpecial: 0
|
|
minUpper: 0
|
|
passwordExpiration: 90
|
|
defaultPolicy: false
|
|
enablePasswdExpiration: false
|
|
requireStrongAuthn: false
|
|
requireStrongAuthOffNetwork: false
|
|
requireStrongAuthUntrustedGeographies: false
|
|
useAccountAttributes: false
|
|
useDictionary: false
|
|
useIdentityAttributes: false
|
|
validateAgainstAccountId: true
|
|
validateAgainstAccountName: true
|
|
sourceIds:
|
|
- 2c91808382ffee0b01830de154f14034
|
|
- 2c91808582ffee0c01830de36511405f
|
|
responses:
|
|
'200':
|
|
description: Reference to the password policy.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1password-policies~1%7Bid%7D/get/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/PasswordPolicyV3Dto.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$PasswordPolicyV3Dto = @"
|
|
{
|
|
"validateAgainstAccountName" : true,
|
|
"minLength" : 8,
|
|
"description" : "Information about the Password Policy",
|
|
"requireStrongAuthUntrustedGeographies" : true,
|
|
"enablePasswdExpiration" : true,
|
|
"minNumeric" : 8,
|
|
"lastUpdated" : "2000-01-23T04:56:07.000+00:00",
|
|
"validateAgainstAccountId" : false,
|
|
"dateCreated" : "2000-01-23T04:56:07.000+00:00",
|
|
"accountNameMinWordLength" : 6,
|
|
"minUpper" : 8,
|
|
"firstExpirationReminder" : 45,
|
|
"modified" : "modified",
|
|
"id" : "2c91808e7d976f3b017d9f5ceae440c8",
|
|
"requireStrongAuthn" : true,
|
|
"useDictionary" : false,
|
|
"minSpecial" : 8,
|
|
"sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ],
|
|
"passwordExpiration" : 8,
|
|
"maxRepeatedChars" : 3,
|
|
"minCharacterTypes" : 5,
|
|
"minAlpha" : 5,
|
|
"created" : "created",
|
|
"useAccountAttributes" : false,
|
|
"accountIdMinWordLength" : 4,
|
|
"minLower" : 8,
|
|
"useIdentityAttributes" : false,
|
|
"defaultPolicy" : true,
|
|
"requireStrongAuthOffNetwork" : true,
|
|
"name" : "PasswordPolicy Example",
|
|
"maxLength" : 25
|
|
}
|
|
"@
|
|
|
|
# Create Password Policy
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto
|
|
New-PasswordPolicy-PasswordPolicyV3Dto $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# New-PasswordPolicy -PasswordPolicyV3Dto $PasswordPolicyV3Dto
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-PasswordPolicy"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
get:
|
|
operationId: listPasswordPolicies
|
|
tags:
|
|
- Password Policies
|
|
summary: List Password Policies
|
|
description: |-
|
|
This gets list of all Password Policies.
|
|
Requires role of ORG_ADMIN
|
|
security:
|
|
- userAuth:
|
|
- idn:password-policy:read
|
|
parameters:
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
responses:
|
|
'200':
|
|
description: List of all Password Policies.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1password-policies~1%7Bid%7D/get/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/PasswordPolicyV3Dto.yaml
|
|
example:
|
|
- description: Example Password Policy
|
|
id: 2c91808e7d976f3b017d9f5ceae440c8
|
|
name: Example PP
|
|
dateCreated: 1639056206564
|
|
lastUpdated: 1662385430753
|
|
firstExpirationReminder: 90
|
|
accountIdMinWordLength: 3
|
|
accountNameMinWordLength: 3
|
|
maxLength: 0
|
|
maxRepeatedChars: 4
|
|
minAlpha: 1
|
|
minCharacterTypes: -1
|
|
minLength: 8
|
|
minLower: 0
|
|
minNumeric: 1
|
|
minSpecial: 0
|
|
minUpper: 0
|
|
passwordExpiration: 90
|
|
defaultPolicy: false
|
|
enablePasswdExpiration: false
|
|
requireStrongAuthn: false
|
|
requireStrongAuthOffNetwork: false
|
|
requireStrongAuthUntrustedGeographies: false
|
|
useAccountAttributes: false
|
|
useDictionary: false
|
|
useIdentityAttributes: false
|
|
validateAgainstAccountId: true
|
|
validateAgainstAccountName: true
|
|
sourceIds:
|
|
- 2c91808382ffee0b01830de154f14034
|
|
- 2c91808582ffee0c01830de36511405f
|
|
- description: null
|
|
id: 2c91808780b8b8430180ff7a093f3bf2
|
|
name: Password Policy 1 test
|
|
dateCreated: 1653553629503
|
|
lastUpdated: null
|
|
firstExpirationReminder: null
|
|
accountIdMinWordLength: -1
|
|
accountNameMinWordLength: -1
|
|
maxLength: 0
|
|
maxRepeatedChars: -1
|
|
minAlpha: 1
|
|
minCharacterTypes: -1
|
|
minLength: 8
|
|
minLower: 0
|
|
minNumeric: 1
|
|
minSpecial: 0
|
|
minUpper: 0
|
|
passwordExpiration: 90
|
|
defaultPolicy: false
|
|
enablePasswdExpiration: false
|
|
requireStrongAuthn: false
|
|
requireStrongAuthOffNetwork: false
|
|
requireStrongAuthUntrustedGeographies: false
|
|
useAccountAttributes: false
|
|
useDictionary: false
|
|
useIdentityAttributes: true
|
|
validateAgainstAccountId: false
|
|
validateAgainstAccountName: false
|
|
sourceIds: []
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
|
|
# List Password Policies
|
|
|
|
try {
|
|
Get-PasswordPolicies
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-PasswordPolicies -Limit $Limit -Offset $Offset -Count $Count
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordPolicies"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/personal-access-tokens:
|
|
get:
|
|
operationId: listPersonalAccessTokens
|
|
security:
|
|
- userAuth:
|
|
- sp:my-personal-access-tokens:read
|
|
- sp:my-personal-access-tokens:manage
|
|
- sp:all-personal-access-tokens:read
|
|
- sp:all-personal-access-tokens:manage
|
|
tags:
|
|
- Personal Access Tokens
|
|
summary: List Personal Access Tokens
|
|
description: This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the 'idn:all-personal-access-tokens:read' right.
|
|
parameters:
|
|
- in: query
|
|
name: owner-id
|
|
description: |-
|
|
The identity ID of the owner whose personal access tokens should be listed. If "me", the caller should have the following right: 'idn:my-personal-access-tokens:read'
|
|
If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'.
|
|
If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read'
|
|
required: false
|
|
schema:
|
|
type: string
|
|
default: null
|
|
example: 2c9180867b50d088017b554662fb281e
|
|
- in: query
|
|
name: filters
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: |-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
**lastUsed**: *le, isnull*
|
|
example: lastUsed le 2023-02-05T10:59:27.214Z
|
|
responses:
|
|
'200':
|
|
description: List of personal access tokens.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The ID of the personal access token (to be used as the username for Basic Auth).
|
|
example: 86f1dc6fe8f54414950454cbb11278fa
|
|
name:
|
|
type: string
|
|
description: The name of the personal access token. Cannot be the same as other personal access tokens owned by a user.
|
|
example: NodeJS Integration
|
|
scope:
|
|
type: array
|
|
nullable: true
|
|
items:
|
|
type: string
|
|
default: sp:scopes:all
|
|
description: Scopes of the personal access token.
|
|
example:
|
|
- demo:personal-access-token-scope:first
|
|
- demo:personal-access-token-scope:second
|
|
owner:
|
|
type: object
|
|
description: Personal access token owner's identity.
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: Personal access token owner's DTO type.
|
|
enum:
|
|
- IDENTITY
|
|
example: IDENTITY
|
|
id:
|
|
type: string
|
|
description: Personal access token owner's identity ID.
|
|
example: 2c9180a46faadee4016fb4e018c20639
|
|
name:
|
|
type: string
|
|
description: Personal access token owner's human-readable display name.
|
|
example: Support
|
|
created:
|
|
type: string
|
|
format: date-time
|
|
description: The date and time, down to the millisecond, when this personal access token was created.
|
|
example: '2017-07-11T18:45:37.098Z'
|
|
lastUsed:
|
|
type: string
|
|
nullable: true
|
|
format: date-time
|
|
description: The date and time, down to the millisecond, when this personal access token was last used to generate an access token. This timestamp does not get updated on every PAT usage, but only once a day. This property can be useful for identifying which PATs are no longer actively used and can be removed.
|
|
example: '2017-07-11T18:45:37.098Z'
|
|
managed:
|
|
type: boolean
|
|
default: false
|
|
example: false
|
|
description: If true, this token is managed by the SailPoint platform, and is not visible in the user interface. For example, Workflows will create managed personal access tokens for users who create workflows.
|
|
required:
|
|
- id
|
|
- name
|
|
- scope
|
|
- owner
|
|
- created
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$OwnerId = "2c9180867b50d088017b554662fb281e" # String | The identity ID of the owner whose personal access tokens should be listed. If ""me"", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional)
|
|
$Filters = "lastUsed le 2023-02-05T10:59:27.214Z" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional)
|
|
|
|
# List Personal Access Tokens
|
|
|
|
try {
|
|
Get-PersonalAccessTokens
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-PersonalAccessTokens -OwnerId $OwnerId -Filters $Filters
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PersonalAccessTokens"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
post:
|
|
operationId: createPersonalAccessToken
|
|
security:
|
|
- userAuth:
|
|
- sp:my-personal-access-tokens:manage
|
|
- sp:all-personal-access-tokens:manage
|
|
tags:
|
|
- Personal Access Tokens
|
|
summary: Create Personal Access Token
|
|
description: This creates a personal access token.
|
|
requestBody:
|
|
description: Name and scope of personal access token.
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
description: Object for specifying the name of a personal access token to create
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: The name of the personal access token (PAT) to be created. Cannot be the same as another PAT owned by the user for whom this PAT is being created.
|
|
example: NodeJS Integration
|
|
scope:
|
|
type: array
|
|
nullable: true
|
|
items:
|
|
type: string
|
|
default: sp:scopes:all
|
|
description: Scopes of the personal access token. If no scope is specified, the token will be created with the default scope "sp:scopes:all". This means the personal access token will have all the rights of the owner who created it.
|
|
example:
|
|
- demo:personal-access-token-scope:first
|
|
- demo:personal-access-token-scope:second
|
|
accessTokenValiditySeconds:
|
|
type: integer
|
|
format: int32
|
|
minimum: 15
|
|
maximum: 43200
|
|
items:
|
|
type: integer
|
|
format: int32
|
|
default: 43200
|
|
description: Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200.
|
|
example: 36900
|
|
required:
|
|
- name
|
|
responses:
|
|
'200':
|
|
description: Created. Note - this is the only time Personal Access Tokens' secret attribute will be displayed.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The ID of the personal access token (to be used as the username for Basic Auth).
|
|
example: 86f1dc6fe8f54414950454cbb11278fa
|
|
secret:
|
|
type: string
|
|
description: The secret of the personal access token (to be used as the password for Basic Auth).
|
|
example: 1d1bef2b9f426383447f64f69349fc7cac176042578d205c256ba3f37c59adb9
|
|
scope:
|
|
type: array
|
|
nullable: true
|
|
items:
|
|
type: string
|
|
default: sp:scopes:all
|
|
description: Scopes of the personal access token.
|
|
example:
|
|
- demo:personal-access-token-scope:first
|
|
- demo:personal-access-token-scope:second
|
|
name:
|
|
type: string
|
|
description: The name of the personal access token. Cannot be the same as other personal access tokens owned by a user.
|
|
example: NodeJS Integration
|
|
owner:
|
|
$ref: '#/paths/~1personal-access-tokens/get/responses/200/content/application~1json/schema/items/properties/owner'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/PatOwner.yaml
|
|
created:
|
|
type: string
|
|
format: date-time
|
|
description: The date and time, down to the millisecond, when this personal access token was created.
|
|
example: '2017-07-11T18:45:37.098Z'
|
|
accessTokenValiditySeconds:
|
|
type: integer
|
|
format: int32
|
|
items:
|
|
type: integer
|
|
format: int32
|
|
default: 43200
|
|
description: Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200.
|
|
example: 36900
|
|
required:
|
|
- id
|
|
- secret
|
|
- scope
|
|
- name
|
|
- owner
|
|
- created
|
|
- accessTokenValiditySeconds
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$CreatePersonalAccessTokenRequest = @"
|
|
{
|
|
"scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ],
|
|
"accessTokenValiditySeconds" : 36900,
|
|
"name" : "NodeJS Integration"
|
|
}
|
|
"@
|
|
|
|
# Create Personal Access Token
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToCreatePersonalAccessTokenRequest -Json $CreatePersonalAccessTokenRequest
|
|
New-PersonalAccessToken-CreatePersonalAccessTokenRequest $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# New-PersonalAccessToken -CreatePersonalAccessTokenRequest $CreatePersonalAccessTokenRequest
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-PersonalAccessToken"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/personal-access-tokens/{id}:
|
|
patch:
|
|
operationId: patchPersonalAccessToken
|
|
security:
|
|
- userAuth:
|
|
- sp:my-personal-access-tokens:manage
|
|
tags:
|
|
- Personal Access Tokens
|
|
summary: Patch Personal Access Token
|
|
description: |-
|
|
This performs a targeted update to the field(s) of a Personal Access Token.
|
|
Changing scopes for a Personal Access Token does not impact existing bearer tokens. You will need to create a new bearer token to have the new scopes. Please note that it can take up to 20 minutes for scope changes to be seen on new bearer tokens.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listPersonalAccessTokens
|
|
description: The Personal Access Token id
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
requestBody:
|
|
required: true
|
|
description: |
|
|
A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
|
|
The following fields are patchable:
|
|
* name
|
|
* scope
|
|
content:
|
|
application/json-patch+json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/JsonPatchOperation.yaml
|
|
example:
|
|
- op: replace
|
|
path: /name
|
|
value: New name
|
|
- op: replace
|
|
path: /scope
|
|
value:
|
|
- sp:scopes:all
|
|
responses:
|
|
'200':
|
|
description: Indicates the PATCH operation succeeded, and returns the PAT's new representation.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1personal-access-tokens/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/GetPersonalAccessTokenResponse.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The Personal Access Token id
|
|
# JsonPatchOperation[] | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope
|
|
$JsonPatchOperation = @"{
|
|
"op" : "replace",
|
|
"path" : "/description",
|
|
"value" : "New description"
|
|
}"@
|
|
|
|
|
|
# Patch Personal Access Token
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
|
|
Update-PersonalAccessToken-Id $Id -JsonPatchOperation $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Update-PersonalAccessToken -Id $Id -JsonPatchOperation $JsonPatchOperation
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-PersonalAccessToken"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
delete:
|
|
operationId: deletePersonalAccessToken
|
|
security:
|
|
- userAuth:
|
|
- sp:my-personal-access-tokens:manage
|
|
- sp:all-personal-access-tokens:manage
|
|
tags:
|
|
- Personal Access Tokens
|
|
summary: Delete Personal Access Token
|
|
description: This deletes a personal access token.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listPersonalAccessTokens
|
|
description: The personal access token id
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
responses:
|
|
'204':
|
|
description: No content.
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The personal access token id
|
|
|
|
# Delete Personal Access Token
|
|
|
|
try {
|
|
Remove-PersonalAccessToken-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Remove-PersonalAccessToken -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-PersonalAccessToken"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/public-identities:
|
|
get:
|
|
operationId: getPublicIdentities
|
|
tags:
|
|
- Public Identities
|
|
summary: Get list of public identities
|
|
description: Get a list of public identities. Set `add-core-filters` to `true` to exclude incomplete identities and uncorrelated accounts.
|
|
security:
|
|
- userAuth:
|
|
- sp:scopes:default
|
|
x-sailpoint-userLevels:
|
|
- USER
|
|
parameters:
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
- in: query
|
|
name: filters
|
|
schema:
|
|
type: string
|
|
required: false
|
|
description: |-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
**id**: *eq, in*
|
|
|
|
**alias**: *eq, sw*
|
|
|
|
**email**: *eq, sw*
|
|
|
|
**firstname**: *eq, sw*
|
|
|
|
**lastname**: *eq, sw*
|
|
example: firstname eq "John"
|
|
- in: query
|
|
name: add-core-filters
|
|
description: |-
|
|
If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*:
|
|
- Should be either correlated or protected.
|
|
- Should not be "spadmin" or "cloudadmin".
|
|
- uid should not be null.
|
|
- lastname should not be null.
|
|
- email should not be null.
|
|
required: false
|
|
example: false
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
- in: query
|
|
name: sorters
|
|
schema:
|
|
type: string
|
|
format: comma-separated
|
|
required: false
|
|
description: |-
|
|
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
|
|
|
Sorting is supported for the following fields: **name**
|
|
example: name
|
|
responses:
|
|
'200':
|
|
description: A list of public identity objects.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
title: Public Identity
|
|
description: Details about a public identity
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: Identity id
|
|
example: 2c9180857182305e0171993735622948
|
|
name:
|
|
type: string
|
|
description: Human-readable display name of identity.
|
|
example: Alison Ferguso
|
|
alias:
|
|
type: string
|
|
description: Alternate unique identifier for the identity.
|
|
example: alison.ferguso
|
|
email:
|
|
nullable: true
|
|
type: string
|
|
description: Email address of identity.
|
|
example: alison.ferguso@acme-solar.com
|
|
status:
|
|
nullable: true
|
|
type: string
|
|
description: The lifecycle status for the identity
|
|
example: Active
|
|
identityState:
|
|
nullable: true
|
|
type: string
|
|
enum:
|
|
- ACTIVE
|
|
- INACTIVE_SHORT_TERM
|
|
- INACTIVE_LONG_TERM
|
|
- null
|
|
example: ACTIVE
|
|
description: |
|
|
The current state of the identity, which determines how Identity Security Cloud interacts with the identity.
|
|
An identity that is Active will be included identity picklists in Request Center, identity processing, and more.
|
|
Identities that are Inactive will be excluded from these features.
|
|
manager:
|
|
type: object
|
|
nullable: true
|
|
description: The manager for the identity.
|
|
properties:
|
|
type:
|
|
$ref: '#/components/schemas/AccessProfileSummary/allOf/0/allOf/1/properties/type'
|
|
example: IDENTITY
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/DtoType.yaml
|
|
id:
|
|
type: string
|
|
description: Identity id
|
|
example: 2c9180a46faadee4016fb4e018c20639
|
|
name:
|
|
type: string
|
|
description: Human-readable display name of identity.
|
|
example: Thomas Edison
|
|
attributes:
|
|
type: array
|
|
description: The public identity attributes of the identity
|
|
items:
|
|
type: object
|
|
properties:
|
|
key:
|
|
type: string
|
|
description: The attribute key
|
|
example: country
|
|
name:
|
|
type: string
|
|
description: Human-readable display name of the attribute
|
|
example: Country
|
|
value:
|
|
type: string
|
|
description: The attribute value
|
|
example: US
|
|
nullable: true
|
|
example:
|
|
- id: 2c9180857182305e0171993735622948
|
|
name: Alison Ferguso
|
|
alias: alison.ferguso
|
|
email: alison.ferguso@acme-solar.com
|
|
status: Active
|
|
manager:
|
|
type: IDENTITY
|
|
id: 2c9180a46faadee4016fb4e018c20639
|
|
name: Thomas Edison
|
|
attributes:
|
|
- key: phone
|
|
name: Phone
|
|
value: '5125551234'
|
|
- key: country
|
|
name: Country
|
|
value: US
|
|
- id: 2c9180a46faadee4016fb4e018c20639
|
|
name: Thomas Edison
|
|
alias: thomas.edison
|
|
email: thomas.edison@acme-solar.com
|
|
status: Active
|
|
manager:
|
|
type: IDENTITY
|
|
id: 2c918086676d3e0601677611dbde220f
|
|
name: Mister Manager
|
|
attributes:
|
|
- key: phone
|
|
name: Phone
|
|
value: '5125554321'
|
|
- key: country
|
|
name: Country
|
|
value: US
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
$Filters = "firstname eq "John"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* (optional)
|
|
$AddCoreFilters = $false # Boolean | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be ""spadmin"" or ""cloudadmin"". - uid should not be null. - lastname should not be null. - email should not be null. (optional) (default to $false)
|
|
$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional)
|
|
|
|
# Get list of public identities
|
|
|
|
try {
|
|
Get-PublicIdentities
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-PublicIdentities -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -AddCoreFilters $AddCoreFilters -Sorters $Sorters
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PublicIdentities"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/public-identities-config:
|
|
get:
|
|
operationId: getPublicIdentityConfig
|
|
tags:
|
|
- Public Identities Config
|
|
summary: Get the Public Identities Configuration
|
|
description: Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns.
|
|
security:
|
|
- userAuth: []
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
responses:
|
|
'200':
|
|
description: Request succeeded.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
description: Details of up to 5 Identity attributes that will be publicly accessible for all Identities to anyone in the org.
|
|
properties:
|
|
attributes:
|
|
type: array
|
|
description: Up to 5 identity attributes that will be available to everyone in the org for all users in the org.
|
|
items:
|
|
type: object
|
|
description: Used to map an attribute key for an Identity to its display name.
|
|
properties:
|
|
key:
|
|
type: string
|
|
description: The attribute key
|
|
example: country
|
|
name:
|
|
type: string
|
|
description: The attribute display name
|
|
example: Country
|
|
modified:
|
|
nullable: true
|
|
type: string
|
|
description: When this configuration was last modified.
|
|
format: date-time
|
|
example: '2018-06-25T20:22:28.104Z'
|
|
modifiedBy:
|
|
$ref: '#/paths/~1public-identities/get/responses/200/content/application~1json/schema/items/properties/manager'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/IdentityReference.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
|
|
# Get the Public Identities Configuration
|
|
|
|
try {
|
|
Get-PublicIdentityConfig
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-PublicIdentityConfig
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PublicIdentityConfig"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
put:
|
|
operationId: updatePublicIdentityConfig
|
|
tags:
|
|
- Public Identities Config
|
|
summary: Update the Public Identities Configuration
|
|
description: Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns.
|
|
security:
|
|
- userAuth: []
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1public-identities-config/get/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/PublicIdentityConfig.yaml
|
|
responses:
|
|
'200':
|
|
description: Request succeeded.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1public-identities-config/get/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/PublicIdentityConfig.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$PublicIdentityConfig = @"
|
|
{
|
|
"modified" : "2018-06-25T20:22:28.104Z",
|
|
"attributes" : [ {
|
|
"name" : "Country",
|
|
"key" : "country"
|
|
}, {
|
|
"name" : "Country",
|
|
"key" : "country"
|
|
} ],
|
|
"modifiedBy" : {
|
|
"name" : "Thomas Edison",
|
|
"id" : "2c9180a46faadee4016fb4e018c20639",
|
|
"type" : "IDENTITY"
|
|
}
|
|
}
|
|
"@
|
|
|
|
# Update the Public Identities Configuration
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig
|
|
Update-PublicIdentityConfig-PublicIdentityConfig $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Update-PublicIdentityConfig -PublicIdentityConfig $PublicIdentityConfig
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-PublicIdentityConfig"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/requestable-objects:
|
|
get:
|
|
operationId: listRequestableObjects
|
|
tags:
|
|
- Requestable Objects
|
|
summary: Requestable Objects List
|
|
security:
|
|
- userAuth: []
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
description: |-
|
|
This endpoint returns a list of acccess items that that can be requested through the Access Request endpoints. Access items are marked with AVAILABLE, PENDING or ASSIGNED with respect to the identity provided using *identity-id* query param.
|
|
Any authenticated token can call this endpoint to see their requestable access items.
|
|
parameters:
|
|
- in: query
|
|
name: identity-id
|
|
required: false
|
|
schema:
|
|
type: string
|
|
example: e7eab60924f64aa284175b9fa3309599
|
|
description: |-
|
|
If present, the value returns only requestable objects for the specified identity.
|
|
* Admin users can call this with any identity ID value.
|
|
* Non-admin users can only specify *me* or pass their own identity ID value.
|
|
* If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result.
|
|
- in: query
|
|
name: types
|
|
description: Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE. If absent, all types are returned. Support for additional types may be added in the future without notice.
|
|
required: false
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/RequestableObject/properties/type'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/RequestableObjectType.yaml
|
|
example: ROLE,ACCESS_PROFILE
|
|
explode: false
|
|
- in: query
|
|
name: term
|
|
required: false
|
|
schema:
|
|
type: string
|
|
example: Finance Role
|
|
description: It allows searching requestable access items with a partial match on the name or description. If term is provided, then the *filter* query parameter will be ignored.
|
|
- in: query
|
|
name: statuses
|
|
description: Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice.
|
|
required: false
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/RequestableObject/properties/requestStatus/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/RequestableObjectRequestStatus.yaml
|
|
explode: false
|
|
example:
|
|
- ASSIGNED
|
|
- PENDING
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
- in: query
|
|
name: filters
|
|
schema:
|
|
type: string
|
|
example: name sw "bob"
|
|
description: |
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
**id**: *eq, in*
|
|
|
|
**name**: *eq, in, sw*
|
|
required: false
|
|
- in: query
|
|
name: sorters
|
|
schema:
|
|
type: string
|
|
format: comma-separated
|
|
required: false
|
|
example: name
|
|
description: |
|
|
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
|
|
|
Sorting is supported for the following fields: **name**
|
|
responses:
|
|
'200':
|
|
description: List of requestable objects
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: Id of the requestable object itself
|
|
example: 2c9180835d2e5168015d32f890ca1581
|
|
name:
|
|
type: string
|
|
description: Human-readable display name of the requestable object
|
|
example: Applied Research Access
|
|
created:
|
|
type: string
|
|
format: date-time
|
|
example: '2017-07-11T18:45:37.098Z'
|
|
description: The time when the requestable object was created
|
|
modified:
|
|
nullable: true
|
|
type: string
|
|
format: date-time
|
|
example: '2018-06-25T20:22:28.104Z'
|
|
description: The time when the requestable object was last modified
|
|
description:
|
|
type: string
|
|
description: Description of the requestable object.
|
|
example: Access to research information, lab results, and schematics.
|
|
nullable: true
|
|
type:
|
|
$ref: '#/components/schemas/RequestableObject/properties/type'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/RequestableObjectType.yaml
|
|
requestStatus:
|
|
allOf:
|
|
- $ref: '#/components/schemas/RequestableObject/properties/requestStatus/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/RequestableObjectRequestStatus.yaml
|
|
- nullable: true
|
|
identityRequestId:
|
|
type: string
|
|
description: If *requestStatus* is *PENDING*, indicates the id of the associated account activity.
|
|
nullable: true
|
|
example: null
|
|
ownerRef:
|
|
$ref: '#/components/schemas/RequestableObject/properties/ownerRef'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/IdentityReferenceWithNameAndEmail.yaml
|
|
requestCommentsRequired:
|
|
type: boolean
|
|
description: Whether the requester must provide comments when requesting the object.
|
|
example: false
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$IdentityId = "e7eab60924f64aa284175b9fa3309599" # String | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. (optional)
|
|
$Types = "ACCESS_PROFILE" # RequestableObjectType[] | Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE. If absent, all types are returned. Support for additional types may be added in the future without notice. (optional)
|
|
|
|
$Types = @"ROLE,ACCESS_PROFILE"@
|
|
$Term = "Finance Role" # String | It allows searching requestable access items with a partial match on the name or description. If term is provided, then the *filter* query parameter will be ignored. (optional)
|
|
$Statuses = "AVAILABLE" # RequestableObjectRequestStatus[] | Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice. (optional)
|
|
|
|
$Statuses = @"[ASSIGNED, PENDING]"@
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
$Filters = "name sw "bob"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional)
|
|
$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional)
|
|
|
|
# Requestable Objects List
|
|
|
|
try {
|
|
Get-RequestableObjects
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-RequestableObjects -IdentityId $IdentityId -Types $Types -Term $Term -Statuses $Statuses -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-RequestableObjects"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/roles:
|
|
get:
|
|
operationId: listRoles
|
|
tags:
|
|
- Roles
|
|
summary: List Roles
|
|
description: This API returns a list of Roles.
|
|
parameters:
|
|
- in: query
|
|
name: for-subadmin
|
|
schema:
|
|
type: string
|
|
description: If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.
|
|
example: 5168015d32f890ca15812c9180835d2e
|
|
required: false
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit50.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
- in: query
|
|
name: filters
|
|
schema:
|
|
type: string
|
|
description: |-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
**id**: *eq, in*
|
|
|
|
**name**: *eq, sw*
|
|
|
|
**created**: *gt, lt, ge, le*
|
|
|
|
**modified**: *gt, lt, ge, le*
|
|
|
|
**owner.id**: *eq, in*
|
|
|
|
**requestable**: *eq*
|
|
example: requestable eq false
|
|
required: false
|
|
- in: query
|
|
name: sorters
|
|
schema:
|
|
type: string
|
|
format: comma-separated
|
|
description: |-
|
|
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
|
|
|
Sorting is supported for the following fields: **name, created, modified**
|
|
example: name,-modified
|
|
required: false
|
|
- in: query
|
|
name: for-segment-ids
|
|
schema:
|
|
type: string
|
|
format: comma-separated
|
|
description: |-
|
|
If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs.
|
|
|
|
If segmentation is currently unavailable, specifying this parameter results in an error.
|
|
example: 0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d
|
|
required: false
|
|
- in: query
|
|
name: include-unsegmented
|
|
schema:
|
|
type: boolean
|
|
default: true
|
|
description: Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.
|
|
example: false
|
|
required: false
|
|
responses:
|
|
'200':
|
|
description: List of Roles
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
description: A Role
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result.
|
|
example: 2c918086749d78830174a1a40e121518
|
|
name:
|
|
type: string
|
|
description: The human-readable display name of the Role
|
|
maxLength: 128
|
|
example: Role 2567
|
|
created:
|
|
type: string
|
|
description: Date the Role was created
|
|
format: date-time
|
|
example: '2021-03-01T22:32:58.104Z'
|
|
readOnly: true
|
|
modified:
|
|
type: string
|
|
description: Date the Role was last modified.
|
|
format: date-time
|
|
example: '2021-03-02T20:22:28.104Z'
|
|
readOnly: true
|
|
description:
|
|
type: string
|
|
nullable: true
|
|
description: A human-readable description of the Role
|
|
example: Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.
|
|
owner:
|
|
$ref: '#/paths/~1access-profiles/get/responses/200/content/application~1json/schema/items/properties/owner'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/access/OwnerReference.yaml
|
|
accessProfiles:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: ID of the Access Profile
|
|
example: ff808081751e6e129f1518161919ecca
|
|
type:
|
|
type: string
|
|
description: Type of requested object. This field must be either left null or set to 'ACCESS_PROFILE' when creating an Access Profile, otherwise a 400 Bad Request error will result.
|
|
enum:
|
|
- ACCESS_PROFILE
|
|
example: ACCESS_PROFILE
|
|
name:
|
|
type: string
|
|
description: Human-readable display name of the Access Profile. This field is ignored on input.
|
|
example: Access Profile 2567
|
|
nullable: true
|
|
entitlements:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1access-profiles/get/responses/200/content/application~1json/schema/items/properties/entitlements/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/access/EntitlementRef.yaml
|
|
membership:
|
|
type: object
|
|
nullable: true
|
|
description: When present, specifies that the Role is to be granted to Identities which either satisfy specific criteria or which are members of a given list of Identities.
|
|
properties:
|
|
type:
|
|
type: string
|
|
enum:
|
|
- STANDARD
|
|
- IDENTITY_LIST
|
|
description: |-
|
|
This enum characterizes the type of a Role's membership selector. Only the following two are fully supported:
|
|
|
|
STANDARD: Indicates that Role membership is defined in terms of a criteria expression
|
|
|
|
IDENTITY_LIST: Indicates that Role membership is conferred on the specific identities listed
|
|
example: IDENTITY_LIST
|
|
criteria:
|
|
type: object
|
|
nullable: true
|
|
description: Defines STANDARD type Role membership
|
|
properties:
|
|
operation:
|
|
type: string
|
|
enum:
|
|
- EQUALS
|
|
- NOT_EQUALS
|
|
- CONTAINS
|
|
- STARTS_WITH
|
|
- ENDS_WITH
|
|
- AND
|
|
- OR
|
|
description: An operation
|
|
example: EQUALS
|
|
key:
|
|
type: object
|
|
nullable: true
|
|
description: Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria
|
|
properties:
|
|
type:
|
|
type: string
|
|
enum:
|
|
- IDENTITY
|
|
- ACCOUNT
|
|
- ENTITLEMENT
|
|
description: Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.
|
|
example: ACCOUNT
|
|
property:
|
|
type: string
|
|
description: The name of the attribute or entitlement to which the associated criteria applies.
|
|
example: attribute.email
|
|
sourceId:
|
|
type: string
|
|
nullable: true
|
|
description: ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT
|
|
example: 2c9180867427f3a301745aec18211519
|
|
required:
|
|
- type
|
|
- property
|
|
stringValue:
|
|
type: string
|
|
nullable: true
|
|
description: String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.
|
|
example: carlee.cert1c9f9b6fd@mailinator.com
|
|
children:
|
|
type: array
|
|
items:
|
|
type: object
|
|
nullable: true
|
|
description: Defines STANDARD type Role membership
|
|
properties:
|
|
operation:
|
|
$ref: '#/paths/~1roles/get/responses/200/content/application~1json/schema/items/properties/membership/properties/criteria/properties/operation'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/access/RoleCriteriaOperation.yaml
|
|
key:
|
|
$ref: '#/paths/~1roles/get/responses/200/content/application~1json/schema/items/properties/membership/properties/criteria/properties/key'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/access/RoleCriteriaKey.yaml
|
|
stringValue:
|
|
type: string
|
|
nullable: true
|
|
description: String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.
|
|
example: carlee.cert1c9f9b6fd@mailinator.com
|
|
children:
|
|
type: array
|
|
items:
|
|
type: object
|
|
description: Defines STANDARD type Role membership
|
|
properties:
|
|
operation:
|
|
$ref: '#/paths/~1roles/get/responses/200/content/application~1json/schema/items/properties/membership/properties/criteria/properties/operation'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/access/RoleCriteriaOperation.yaml
|
|
key:
|
|
$ref: '#/paths/~1roles/get/responses/200/content/application~1json/schema/items/properties/membership/properties/criteria/properties/key'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/access/RoleCriteriaKey.yaml
|
|
stringValue:
|
|
type: string
|
|
description: String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.
|
|
example: carlee.cert1c9f9b6fd@mailinator.com
|
|
nullable: true
|
|
description: Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa.
|
|
nullable: true
|
|
description: Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa.
|
|
identities:
|
|
type: array
|
|
items:
|
|
type: object
|
|
description: A reference to an Identity in an IDENTITY_LIST role membership criteria.
|
|
properties:
|
|
type:
|
|
$ref: '#/components/schemas/AccessProfileSummary/allOf/0/allOf/1/properties/type'
|
|
nullable: true
|
|
example: IDENTITY
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/DtoType.yaml
|
|
id:
|
|
type: string
|
|
description: Identity id
|
|
example: 2c9180a46faadee4016fb4e018c20639
|
|
name:
|
|
type: string
|
|
nullable: true
|
|
description: Human-readable display name of the Identity.
|
|
example: Thomas Edison
|
|
aliasName:
|
|
type: string
|
|
nullable: true
|
|
description: User name of the Identity
|
|
example: t.edison
|
|
nullable: true
|
|
description: Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST.
|
|
legacyMembershipInfo:
|
|
type: object
|
|
nullable: true
|
|
description: This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration.
|
|
example:
|
|
type: IDENTITY_LIST
|
|
additionalProperties: true
|
|
enabled:
|
|
type: boolean
|
|
description: Whether the Role is enabled or not.
|
|
example: true
|
|
default: false
|
|
requestable:
|
|
type: boolean
|
|
description: Whether the Role can be the target of access requests.
|
|
example: true
|
|
default: false
|
|
accessRequestConfig:
|
|
type: object
|
|
properties:
|
|
commentsRequired:
|
|
type: boolean
|
|
description: Whether the requester of the containing object must provide comments justifying the request
|
|
example: true
|
|
nullable: true
|
|
default: false
|
|
denialCommentsRequired:
|
|
type: boolean
|
|
description: Whether an approver must provide comments when denying the request
|
|
example: true
|
|
nullable: true
|
|
default: false
|
|
approvalSchemes:
|
|
type: array
|
|
description: List describing the steps in approving the request
|
|
items:
|
|
type: object
|
|
properties:
|
|
approverType:
|
|
type: string
|
|
enum:
|
|
- OWNER
|
|
- MANAGER
|
|
- GOVERNANCE_GROUP
|
|
description: |-
|
|
Describes the individual or group that is responsible for an approval step. Values are as follows.
|
|
|
|
**OWNER**: Owner of the associated Role
|
|
|
|
**MANAGER**: Manager of the Identity making the request
|
|
|
|
**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field
|
|
example: GOVERNANCE_GROUP
|
|
approverId:
|
|
type: string
|
|
nullable: true
|
|
description: Id of the specific approver, used only when approverType is GOVERNANCE_GROUP
|
|
example: 46c79819-a69f-49a2-becb-12c971ae66c6
|
|
revocationRequestConfig:
|
|
type: object
|
|
properties:
|
|
commentsRequired:
|
|
type: boolean
|
|
description: Whether the requester of the containing object must provide comments justifying the request
|
|
example: false
|
|
nullable: true
|
|
default: false
|
|
denialCommentsRequired:
|
|
type: boolean
|
|
description: Whether an approver must provide comments when denying the request
|
|
example: false
|
|
nullable: true
|
|
default: false
|
|
approvalSchemes:
|
|
type: array
|
|
description: List describing the steps in approving the revocation request
|
|
items:
|
|
$ref: '#/paths/~1roles/get/responses/200/content/application~1json/schema/items/properties/accessRequestConfig/properties/approvalSchemes/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/access/ApprovalSchemeForRole.yaml
|
|
segments:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: List of IDs of segments, if any, to which this Role is assigned.
|
|
example:
|
|
- f7b1b8a3-5fed-4fd4-ad29-82014e137e19
|
|
- 29cb6c06-1da8-43ea-8be4-b3125f248f2a
|
|
dimensional:
|
|
description: Whether the Role is dimensional.
|
|
type: boolean
|
|
nullable: true
|
|
default: false
|
|
dimensionRefs:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
enum:
|
|
- DIMENSION
|
|
description: The type of the object to which this reference applies
|
|
example: DIMENSION
|
|
id:
|
|
type: string
|
|
description: ID of the object to which this reference applies
|
|
example: 2c91808568c529c60168cca6f90c1313
|
|
name:
|
|
type: string
|
|
description: Human-readable display name of the object to which this reference applies
|
|
example: Role 2
|
|
nullable: true
|
|
description: List of references to dimensions to which this Role is assigned. This field is only relevant if the Role is dimensional.
|
|
accessModelMetadata:
|
|
type: object
|
|
properties:
|
|
attributes:
|
|
type: array
|
|
nullable: true
|
|
items:
|
|
type: object
|
|
properties:
|
|
key:
|
|
type: string
|
|
description: Technical name of the Attribute. This is unique and cannot be changed after creation.
|
|
example: iscPrivacy
|
|
name:
|
|
type: string
|
|
description: The display name of the key.
|
|
example: Privacy
|
|
multiselect:
|
|
type: boolean
|
|
default: false
|
|
description: Indicates whether the attribute can have multiple values.
|
|
example: false
|
|
status:
|
|
type: string
|
|
description: The status of the Attribute.
|
|
example: active
|
|
type:
|
|
type: string
|
|
description: The type of the Attribute. This can be either "custom" or "governance".
|
|
example: governance
|
|
objectTypes:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
description: An array of object types this attributes values can be applied to. Possible values are "all" or "entitlement". Value "all" means this attribute can be used with all object types that are supported.
|
|
example:
|
|
- entitlement
|
|
description:
|
|
type: string
|
|
description: The description of the Attribute.
|
|
example: Specifies the level of privacy associated with an access item.
|
|
values:
|
|
type: array
|
|
nullable: true
|
|
items:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: string
|
|
description: Technical name of the Attribute value. This is unique and cannot be changed after creation.
|
|
example: public
|
|
name:
|
|
type: string
|
|
description: The display name of the Attribute value.
|
|
example: Public
|
|
status:
|
|
type: string
|
|
description: The status of the Attribute value.
|
|
example: active
|
|
example:
|
|
- key: iscPrivacy
|
|
name: Privacy
|
|
multiselect: false
|
|
status: active
|
|
type: governance
|
|
objectTypes:
|
|
- all
|
|
description: Specifies the level of privacy associated with an access item.
|
|
values:
|
|
- value: public
|
|
name: Public
|
|
status: active
|
|
required:
|
|
- name
|
|
- owner
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:role-unchecked:read
|
|
- idn:role-unchecked:manage
|
|
- idn:role-checked:manage
|
|
- idn:role-checked:read
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- ROLE_ADMIN
|
|
- ROLE_SUBADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional)
|
|
$Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50)
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
$Filters = "requestable eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional)
|
|
$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional)
|
|
$ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional)
|
|
$IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true)
|
|
|
|
# List Roles
|
|
|
|
try {
|
|
Get-Roles
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-Roles -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Roles"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
post:
|
|
operationId: createRole
|
|
tags:
|
|
- Roles
|
|
summary: Create a Role
|
|
description: |-
|
|
This API creates a role.
|
|
In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves.
|
|
|
|
The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters.
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1roles/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/access/Role.yaml
|
|
responses:
|
|
'201':
|
|
description: Role created
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1roles/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/access/Role.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:role-unchecked:manage
|
|
- idn:role-checked:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- ROLE_ADMIN
|
|
- ROLE_SUBADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Role = @"
|
|
{
|
|
"owner" : {
|
|
"name" : "support",
|
|
"id" : "2c9180a46faadee4016fb4e018c20639",
|
|
"type" : "IDENTITY"
|
|
},
|
|
"entitlements" : [ {
|
|
"name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local",
|
|
"id" : "2c91809773dee32014e13e122092014e",
|
|
"type" : "ENTITLEMENT"
|
|
}, {
|
|
"name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local",
|
|
"id" : "2c91809773dee32014e13e122092014e",
|
|
"type" : "ENTITLEMENT"
|
|
} ],
|
|
"dimensional" : false,
|
|
"created" : "2021-03-01T22:32:58.104Z",
|
|
"dimensionRefs" : [ {
|
|
"name" : "Role 2",
|
|
"id" : "2c91808568c529c60168cca6f90c1313",
|
|
"type" : "DIMENSION"
|
|
}, {
|
|
"name" : "Role 2",
|
|
"id" : "2c91808568c529c60168cca6f90c1313",
|
|
"type" : "DIMENSION"
|
|
} ],
|
|
"description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.",
|
|
"membership" : {
|
|
"identities" : [ {
|
|
"aliasName" : "t.edison",
|
|
"name" : "Thomas Edison",
|
|
"id" : "2c9180a46faadee4016fb4e018c20639",
|
|
"type" : "IDENTITY"
|
|
}, {
|
|
"aliasName" : "t.edison",
|
|
"name" : "Thomas Edison",
|
|
"id" : "2c9180a46faadee4016fb4e018c20639",
|
|
"type" : "IDENTITY"
|
|
} ],
|
|
"criteria" : {
|
|
"stringValue" : "carlee.cert1c9f9b6fd@mailinator.com",
|
|
"children" : [ {
|
|
"stringValue" : "carlee.cert1c9f9b6fd@mailinator.com",
|
|
"children" : [ {
|
|
"stringValue" : "carlee.cert1c9f9b6fd@mailinator.com",
|
|
"operation" : "EQUALS",
|
|
"key" : {
|
|
"sourceId" : "2c9180867427f3a301745aec18211519",
|
|
"property" : "attribute.email",
|
|
"type" : "ACCOUNT"
|
|
}
|
|
}, {
|
|
"stringValue" : "carlee.cert1c9f9b6fd@mailinator.com",
|
|
"operation" : "EQUALS",
|
|
"key" : {
|
|
"sourceId" : "2c9180867427f3a301745aec18211519",
|
|
"property" : "attribute.email",
|
|
"type" : "ACCOUNT"
|
|
}
|
|
} ],
|
|
"operation" : "EQUALS",
|
|
"key" : {
|
|
"sourceId" : "2c9180867427f3a301745aec18211519",
|
|
"property" : "attribute.email",
|
|
"type" : "ACCOUNT"
|
|
}
|
|
}, {
|
|
"stringValue" : "carlee.cert1c9f9b6fd@mailinator.com",
|
|
"children" : [ {
|
|
"stringValue" : "carlee.cert1c9f9b6fd@mailinator.com",
|
|
"operation" : "EQUALS",
|
|
"key" : {
|
|
"sourceId" : "2c9180867427f3a301745aec18211519",
|
|
"property" : "attribute.email",
|
|
"type" : "ACCOUNT"
|
|
}
|
|
}, {
|
|
"stringValue" : "carlee.cert1c9f9b6fd@mailinator.com",
|
|
"operation" : "EQUALS",
|
|
"key" : {
|
|
"sourceId" : "2c9180867427f3a301745aec18211519",
|
|
"property" : "attribute.email",
|
|
"type" : "ACCOUNT"
|
|
}
|
|
} ],
|
|
"operation" : "EQUALS",
|
|
"key" : {
|
|
"sourceId" : "2c9180867427f3a301745aec18211519",
|
|
"property" : "attribute.email",
|
|
"type" : "ACCOUNT"
|
|
}
|
|
} ],
|
|
"operation" : "EQUALS",
|
|
"key" : {
|
|
"sourceId" : "2c9180867427f3a301745aec18211519",
|
|
"property" : "attribute.email",
|
|
"type" : "ACCOUNT"
|
|
}
|
|
},
|
|
"type" : "IDENTITY_LIST"
|
|
},
|
|
"enabled" : true,
|
|
"revocationRequestConfig" : {
|
|
"commentsRequired" : false,
|
|
"approvalSchemes" : [ {
|
|
"approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6",
|
|
"approverType" : "GOVERNANCE_GROUP"
|
|
}, {
|
|
"approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6",
|
|
"approverType" : "GOVERNANCE_GROUP"
|
|
} ],
|
|
"denialCommentsRequired" : false
|
|
},
|
|
"segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ],
|
|
"legacyMembershipInfo" : {
|
|
"type" : "IDENTITY_LIST"
|
|
},
|
|
"accessRequestConfig" : {
|
|
"commentsRequired" : true,
|
|
"approvalSchemes" : [ {
|
|
"approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6",
|
|
"approverType" : "GOVERNANCE_GROUP"
|
|
}, {
|
|
"approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6",
|
|
"approverType" : "GOVERNANCE_GROUP"
|
|
} ],
|
|
"denialCommentsRequired" : true
|
|
},
|
|
"accessProfiles" : [ {
|
|
"name" : "Access Profile 2567",
|
|
"id" : "ff808081751e6e129f1518161919ecca",
|
|
"type" : "ACCESS_PROFILE"
|
|
}, {
|
|
"name" : "Access Profile 2567",
|
|
"id" : "ff808081751e6e129f1518161919ecca",
|
|
"type" : "ACCESS_PROFILE"
|
|
} ],
|
|
"name" : "Role 2567",
|
|
"modified" : "2021-03-02T20:22:28.104Z",
|
|
"accessModelMetadata" : {
|
|
"attributes" : [ {
|
|
"key" : "iscPrivacy",
|
|
"name" : "Privacy",
|
|
"multiselect" : false,
|
|
"status" : "active",
|
|
"type" : "governance",
|
|
"objectTypes" : [ "all" ],
|
|
"description" : "Specifies the level of privacy associated with an access item.",
|
|
"values" : [ {
|
|
"value" : "public",
|
|
"name" : "Public",
|
|
"status" : "active"
|
|
} ]
|
|
} ]
|
|
},
|
|
"id" : "2c918086749d78830174a1a40e121518",
|
|
"requestable" : true
|
|
}
|
|
"@
|
|
|
|
# Create a Role
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToRole -Json $Role
|
|
New-Role-Role $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# New-Role -Role $Role
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Role"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/roles/{id}:
|
|
get:
|
|
operationId: getRole
|
|
tags:
|
|
- Roles
|
|
summary: Get a Role
|
|
description: |-
|
|
This API returns a Role by its ID.
|
|
A user with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listRoles
|
|
schema:
|
|
type: string
|
|
description: ID of the Role
|
|
example: 2c91808a7813090a017814121e121518
|
|
responses:
|
|
'200':
|
|
description: List of all Roles
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1roles/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/access/Role.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:role-unchecked:read
|
|
- idn:role-unchecked:manage
|
|
- idn:role-checked:manage
|
|
- idn:role-checked:read
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- ROLE_ADMIN
|
|
- ROLE_SUBADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "2c91808a7813090a017814121e121518" # String | ID of the Role
|
|
|
|
# Get a Role
|
|
|
|
try {
|
|
Get-Role-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-Role -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Role"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
patch:
|
|
operationId: patchRole
|
|
tags:
|
|
- Roles
|
|
summary: Patch a specified Role
|
|
description: |-
|
|
This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
|
|
The following fields are patchable:
|
|
* name
|
|
* description
|
|
* enabled
|
|
* owner
|
|
* accessProfiles
|
|
* entitlements
|
|
* membership
|
|
* requestable
|
|
* accessRequestConfig
|
|
* revokeRequestConfig
|
|
* segments
|
|
* accessModelMetadata
|
|
|
|
A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
|
|
|
|
The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters.
|
|
|
|
When you use this API to modify a role's membership identities, you can only modify up to a limit of 500 membership identities at a time.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: ID of the Role to patch
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listRoles
|
|
schema:
|
|
type: string
|
|
example: 2c91808a7813090a017814121e121518
|
|
requestBody:
|
|
content:
|
|
application/json-patch+json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/JsonPatchOperation.yaml
|
|
examples:
|
|
Make a Role Requestable and Enable it in One Call:
|
|
description: This example shows how multiple fields may be updated with a single patch call.
|
|
value:
|
|
- op: replace
|
|
path: /requestable
|
|
value: true
|
|
- op: replace
|
|
path: /enabled
|
|
value: true
|
|
Assign a Role to a Segment:
|
|
description: This example illustrates the use of patch to assign a Role to a Segment by adding the Segment's ID to the Role's segments array.
|
|
value:
|
|
- op: add
|
|
path: /segments/-
|
|
value: f7b1b8a3-5fed-4fd4-ad29-82014e137e19
|
|
Set the Membership Selection Criteria to a List of Identities:
|
|
description: This example shows how to define a Role's membershp by providing a list of Identities, referenced by their IDs.
|
|
value:
|
|
- op: replace
|
|
path: /membership
|
|
value:
|
|
type: IDENTITY_LIST
|
|
identities:
|
|
- id: 2c91808973fe906c0174262092014ed9
|
|
- id: 2c918086262092014ed94fb8a47612f3
|
|
Set the Membership Selection Criteria to a Standard Expression:
|
|
description: This example shows how to define a Role's membership using STANDARD criteria. In this case, the Role will be granted to all Identities which have the *Engineering* attribute from the indicated Source.
|
|
value:
|
|
- op: replace
|
|
path: /membership
|
|
value:
|
|
type: STANDARD
|
|
criteria:
|
|
operation: OR
|
|
children:
|
|
- operation: EQUALS
|
|
key:
|
|
type: ENTITLEMENT
|
|
property: attribute.memberOf
|
|
sourceId: 2c9180887701fb2014213e122092014e
|
|
stringValue: Engineering
|
|
Add a New Clause as the Child of an Existing Standard Expression:
|
|
description: This example shows how to add a child clause to an existing STANDARD criteria expression.
|
|
value:
|
|
- op: add
|
|
path: /membership/criteria/children/-
|
|
value:
|
|
operation: ENDS_WITH
|
|
key:
|
|
type: IDENTITY
|
|
property: attribute.email
|
|
stringValue: '@identitynow.com'
|
|
Assign a Access Model Metadata to a Role:
|
|
description: This example shows how to assign a existing metadata to a role.
|
|
value:
|
|
- op: add
|
|
path: /accessModelMetadata/attributes/0
|
|
value:
|
|
key: iscFederalClassifications
|
|
values:
|
|
- value: secret
|
|
Add an Access Profile to a Role:
|
|
description: This example shows how to add an access profile to a role.
|
|
value:
|
|
- op: add
|
|
path: /accessProfiles/-
|
|
value:
|
|
id: 1de104e1f9024b1289b3a31e22d28cd1
|
|
type: ACCESS_PROFILE
|
|
Add an Entitlement to a Role:
|
|
description: This example shows how to add an entitlement to a role.
|
|
value:
|
|
- op: add
|
|
path: /entitlements/-
|
|
value:
|
|
id: 0fb2f8051e48421b8f1f8a64aee3b205
|
|
type: ENTITLEMENT
|
|
required: true
|
|
responses:
|
|
'200':
|
|
description: Responds with the Role as updated.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1roles/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/access/Role.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:role-unchecked:manage
|
|
- idn:role-checked:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- ROLE_ADMIN
|
|
- ROLE_SUBADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "2c91808a7813090a017814121e121518" # String | ID of the Role to patch
|
|
# JsonPatchOperation[] |
|
|
$JsonPatchOperation = @"{
|
|
"op" : "replace",
|
|
"path" : "/description",
|
|
"value" : "New description"
|
|
}"@
|
|
|
|
|
|
# Patch a specified Role
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
|
|
Update-Role-Id $Id -JsonPatchOperation $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Update-Role -Id $Id -JsonPatchOperation $JsonPatchOperation
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Role"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
delete:
|
|
operationId: deleteRole
|
|
tags:
|
|
- Roles
|
|
summary: Delete a Role
|
|
description: |-
|
|
This API deletes a Role by its ID.
|
|
|
|
A user with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listRoles
|
|
schema:
|
|
type: string
|
|
description: ID of the Role
|
|
example: 2c91808a7813090a017814121e121518
|
|
responses:
|
|
'204':
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/204.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:role-unchecked:manage
|
|
- idn:role-checked:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- ROLE_ADMIN
|
|
- ROLE_SUBADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "2c91808a7813090a017814121e121518" # String | ID of the Role
|
|
|
|
# Delete a Role
|
|
|
|
try {
|
|
Remove-Role-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Remove-Role -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Role"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/roles/bulk-delete:
|
|
post:
|
|
operationId: deleteBulkRoles
|
|
summary: Delete Role(s)
|
|
tags:
|
|
- Roles
|
|
description: |-
|
|
This endpoint initiates a bulk deletion of one or more roles.
|
|
When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information.
|
|
This endpoint can only bulk delete up to a limit of 50 roles per request.
|
|
A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of.
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
roleIds:
|
|
description: List of IDs of Roles to be deleted.
|
|
type: array
|
|
items:
|
|
type: string
|
|
example:
|
|
- 2c9180847812e0b1017817051919ecca
|
|
- 2c9180887812e0b201781e129f151816
|
|
required:
|
|
- roleIds
|
|
example:
|
|
roleIds:
|
|
- 2c91808876438bb2017668b91919ecca
|
|
- 2c91808876438ba801766e129f151816
|
|
responses:
|
|
'202':
|
|
description: Returns an object with the id of the task performing the delete operation.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
description: Task result.
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: Task result DTO type.
|
|
enum:
|
|
- TASK_RESULT
|
|
example: TASK_RESULT
|
|
id:
|
|
type: string
|
|
description: Task result ID.
|
|
example: 464ae7bf791e49fdb74606a2e4a89635
|
|
name:
|
|
type: string
|
|
description: Task result display name.
|
|
nullable: true
|
|
example: null
|
|
example:
|
|
type: TASK_RESULT
|
|
id: 464ae7bf791e49fdb74606a2e4a89635
|
|
name: null
|
|
'400':
|
|
description: Client Error - Returned if the request body is invalid.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/400/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ErrorResponseDto.yaml
|
|
examples:
|
|
400.1 Bad Request Content:
|
|
description: Response for bad request content
|
|
value:
|
|
detailCode: 400.1 Bad Request Content
|
|
trackingId: 1ea1adcb84da4dcb890145e05745774e
|
|
messages:
|
|
- locale: en-US
|
|
localeOrigin: DEFAULT
|
|
text: The request was syntactically correct but its content is semantically invalid.
|
|
400.1 Role ids limit violation:
|
|
description: Role ids limit violation response
|
|
value:
|
|
detailCode: 400.1 Bad Request Content
|
|
trackingId: 77aa89ac6f0e422dbc588866abc22be9
|
|
messages:
|
|
- locale: en-US
|
|
localeOrigin: DEFAULT
|
|
text: roleIds count exceeded max limit of 50 for bulk-delete.
|
|
400.1.404 Referenced object not found:
|
|
description: Referenced object not found response
|
|
value:
|
|
detailCode: 400.1.404 Referenced object not found
|
|
trackingId: 77aa89ac6f0e422dbc588866abc22be9
|
|
messages:
|
|
- locale: en-US
|
|
localeOrigin: DEFAULT
|
|
text: Referenced roleIds ["2c91808876438bb2017668b91919ecca"] was not found.
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:role-unchecked:manage
|
|
- idn:role-checked:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- ROLE_ADMIN
|
|
- ROLE_SUBADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$RoleBulkDeleteRequest = @"
|
|
{
|
|
"roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ]
|
|
}
|
|
"@
|
|
|
|
# Delete Role(s)
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest
|
|
Remove-BulkRoles-RoleBulkDeleteRequest $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Remove-BulkRoles -RoleBulkDeleteRequest $RoleBulkDeleteRequest
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BulkRoles"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/roles/{id}/assigned-identities:
|
|
get:
|
|
operationId: getRoleAssignedIdentities
|
|
tags:
|
|
- Roles
|
|
summary: List Identities assigned a Role
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
description: ID of the Role for which the assigned Identities are to be listed
|
|
example: 2c91808a7813090a017814121e121518
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listRoles
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
- in: query
|
|
name: filters
|
|
schema:
|
|
type: string
|
|
description: |-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
**id**: *eq, in*
|
|
|
|
**aliasName**: *eq, sw*
|
|
|
|
**email**: *eq, sw*
|
|
|
|
**name**: *eq, sw, co*
|
|
example: name sw Joe
|
|
- in: query
|
|
name: sorters
|
|
schema:
|
|
type: string
|
|
format: comma-separated
|
|
description: |-
|
|
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
|
|
|
Sorting is supported for the following fields: **id, name, aliasName, email**
|
|
example: aliasName,name
|
|
responses:
|
|
'200':
|
|
description: List of Identities assigned the Role
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
description: A subset of the fields of an Identity which is a member of a Role.
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The ID of the Identity
|
|
example: 2c9180a46faadee4016fb4e018c20639
|
|
aliasName:
|
|
type: string
|
|
description: The alias / username of the Identity
|
|
example: t.edison
|
|
name:
|
|
type: string
|
|
description: The human-readable display name of the Identity
|
|
example: Thomas Edison
|
|
email:
|
|
type: string
|
|
description: Email address of the Identity
|
|
example: t.edison@identitynow.com
|
|
roleAssignmentSource:
|
|
type: string
|
|
enum:
|
|
- ACCESS_REQUEST
|
|
- ROLE_MEMBERSHIP
|
|
description: Type which indicates how a particular Identity obtained a particular Role
|
|
example: ACCESS_REQUEST
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:role-unchecked:read
|
|
- idn:role-unchecked:manage
|
|
- idn:role-checked:manage
|
|
- idn:role-checked:read
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "2c91808a7813090a017814121e121518" # String | ID of the Role for which the assigned Identities are to be listed
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
$Filters = "name sw Joe" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional)
|
|
$Sorters = "aliasName,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** (optional)
|
|
|
|
# List Identities assigned a Role
|
|
|
|
try {
|
|
Get-RoleAssignedIdentities-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-RoleAssignedIdentities -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-RoleAssignedIdentities"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/saved-searches:
|
|
post:
|
|
security:
|
|
- userAuth:
|
|
- sp:saved-search:create
|
|
tags:
|
|
- Saved Search
|
|
description: |
|
|
Creates a new saved search.
|
|
summary: Create a saved search
|
|
operationId: createSavedSearch
|
|
requestBody:
|
|
description: The saved search to persist.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/components/schemas/SavedSearch/allOf/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/saved/SavedSearchName.yaml
|
|
- $ref: '#/components/schemas/SavedSearch/allOf/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/saved/SavedSearchDetail.yaml
|
|
required: true
|
|
responses:
|
|
'201':
|
|
description: The persisted saved search.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
allOf:
|
|
- type: object
|
|
properties:
|
|
id:
|
|
description: |
|
|
The saved search ID.
|
|
type: string
|
|
example: 0de46054-fe90-434a-b84e-c6b3359d0c64
|
|
owner:
|
|
description: |
|
|
The owner of the saved search.
|
|
$ref: '#/components/schemas/SavedSearch/allOf/0/properties/owner'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/TypedReference.yaml
|
|
ownerId:
|
|
type: string
|
|
description: The ID of the identity that owns this saved search.
|
|
example: 2c91808568c529c60168cca6f90c1313
|
|
public:
|
|
type: boolean
|
|
description: Whether this saved search is visible to anyone but the owner. This field will always be false as there is no way to set a saved search as public at this time.
|
|
default: false
|
|
example: false
|
|
- $ref: '#/components/schemas/SavedSearch/allOf/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/saved/SavedSearchName.yaml
|
|
- $ref: '#/components/schemas/SavedSearch/allOf/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/saved/SavedSearchDetail.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$CreateSavedSearchRequest = @"
|
|
|
|
"@
|
|
|
|
# Create a saved search
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToCreateSavedSearchRequest -Json $CreateSavedSearchRequest
|
|
New-SavedSearch-CreateSavedSearchRequest $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# New-SavedSearch -CreateSavedSearchRequest $CreateSavedSearchRequest
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SavedSearch"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
get:
|
|
security:
|
|
- userAuth:
|
|
- sp:saved-search:read
|
|
tags:
|
|
- Saved Search
|
|
description: |
|
|
Returns a list of saved searches.
|
|
summary: A list of Saved Searches
|
|
operationId: listSavedSearches
|
|
parameters:
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
- name: filters
|
|
in: query
|
|
schema:
|
|
type: string
|
|
description: |-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
**owner.id**: *eq*
|
|
example: owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"
|
|
responses:
|
|
'200':
|
|
description: The list of requested saved searches.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1saved-searches/post/responses/201/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/saved/SavedSearch.yaml
|
|
headers:
|
|
X-Total-Count:
|
|
description: The total result count (returned only if the *count* parameter is specified as *true*).
|
|
schema:
|
|
type: integer
|
|
example: 5
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
$Filters = "owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* (optional)
|
|
|
|
# A list of Saved Searches
|
|
|
|
try {
|
|
Get-SavedSearches
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-SavedSearches -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SavedSearches"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/saved-searches/{id}:
|
|
put:
|
|
tags:
|
|
- Saved Search
|
|
description: |
|
|
Updates an existing saved search.
|
|
|
|
>**NOTE: You cannot update the `owner` of the saved search.**
|
|
summary: |
|
|
Updates an existing saved search
|
|
operationId: putSavedSearch
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
description: ID of the requested document.
|
|
schema:
|
|
type: string
|
|
required: true
|
|
example: 2c91808568c529c60168cca6f90c1313
|
|
x-sailpoint-resource-operation-id:
|
|
- listAccessProfiles
|
|
- listAccountActivities
|
|
- listEntitlements
|
|
- listRoles
|
|
- listIdentities
|
|
requestBody:
|
|
description: The saved search to persist.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1saved-searches/post/responses/201/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/saved/SavedSearch.yaml
|
|
required: true
|
|
responses:
|
|
'200':
|
|
description: The persisted saved search.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1saved-searches/post/responses/201/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/saved/SavedSearch.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document.
|
|
$SavedSearch = @"
|
|
{
|
|
"owner" : {
|
|
"id" : "2c91808568c529c60168cca6f90c1313",
|
|
"type" : "IDENTITY"
|
|
},
|
|
"created" : "2018-06-25T20:22:28.104Z",
|
|
"columns" : {
|
|
"identity" : [ {
|
|
"field" : "displayName",
|
|
"header" : "Display Name"
|
|
}, {
|
|
"field" : "e-mail",
|
|
"header" : "Work Email"
|
|
} ]
|
|
},
|
|
"query" : "@accounts(disabled:true)",
|
|
"description" : "Disabled accounts",
|
|
"orderBy" : {
|
|
"identity" : [ "lastName", "firstName" ],
|
|
"role" : [ "name" ]
|
|
},
|
|
"sort" : [ "displayName" ],
|
|
"filters" : {
|
|
"terms" : [ "account_count", "account_count" ],
|
|
"range" : {
|
|
"lower" : {
|
|
"inclusive" : false,
|
|
"value" : "1"
|
|
},
|
|
"upper" : {
|
|
"inclusive" : false,
|
|
"value" : "1"
|
|
}
|
|
},
|
|
"exclude" : false,
|
|
"type" : "RANGE"
|
|
},
|
|
"ownerId" : "2c91808568c529c60168cca6f90c1313",
|
|
"indices" : [ "identities" ],
|
|
"public" : false,
|
|
"name" : "Disabled accounts",
|
|
"modified" : "2018-06-25T20:22:28.104Z",
|
|
"id" : "0de46054-fe90-434a-b84e-c6b3359d0c64",
|
|
"fields" : [ "disabled" ]
|
|
}
|
|
"@
|
|
|
|
# Updates an existing saved search
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToSavedSearch -Json $SavedSearch
|
|
Send-SavedSearch-Id $Id -SavedSearch $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Send-SavedSearch -Id $Id -SavedSearch $SavedSearch
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SavedSearch"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
get:
|
|
tags:
|
|
- Saved Search
|
|
description: |
|
|
Returns the specified saved search.
|
|
summary: Return saved search by ID
|
|
operationId: getSavedSearch
|
|
parameters:
|
|
- $ref: '#/paths/~1saved-searches~1%7Bid%7D/put/parameters/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/path/search/id.yaml
|
|
responses:
|
|
'200':
|
|
description: The requested saved search.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1saved-searches/post/responses/201/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/saved/SavedSearch.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document.
|
|
|
|
# Return saved search by ID
|
|
|
|
try {
|
|
Get-SavedSearch-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-SavedSearch -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SavedSearch"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
delete:
|
|
tags:
|
|
- Saved Search
|
|
description: |
|
|
Deletes the specified saved search.
|
|
summary: Delete document by ID
|
|
operationId: deleteSavedSearch
|
|
parameters:
|
|
- $ref: '#/paths/~1saved-searches~1%7Bid%7D/put/parameters/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/path/search/id.yaml
|
|
responses:
|
|
'204':
|
|
description: No Content - Indicates the request was successful but there is no content to be returned in the response.
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document.
|
|
|
|
# Delete document by ID
|
|
|
|
try {
|
|
Remove-SavedSearch-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Remove-SavedSearch -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SavedSearch"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/saved-searches/{id}/execute:
|
|
post:
|
|
tags:
|
|
- Saved Search
|
|
description: |
|
|
Executes the specified saved search.
|
|
summary: Execute a saved search by ID
|
|
operationId: executeSavedSearch
|
|
parameters:
|
|
- $ref: '#/paths/~1saved-searches~1%7Bid%7D/put/parameters/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/path/search/id.yaml
|
|
requestBody:
|
|
description: |
|
|
When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search.
|
|
|
|
If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
scheduleId:
|
|
description: |
|
|
The ID of the scheduled search that triggered the saved search execution.
|
|
type: string
|
|
example: 7a724640-0c17-4ce9-a8c3-4a89738459c8
|
|
owner:
|
|
description: |
|
|
The owner of the scheduled search being tested.
|
|
allOf:
|
|
- $ref: '#/components/schemas/SavedSearch/allOf/0/properties/owner'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/TypedReference.yaml
|
|
recipients:
|
|
description: |
|
|
The email recipients of the scheduled search being tested.
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/SavedSearch/allOf/0/properties/owner'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/TypedReference.yaml
|
|
examples:
|
|
scheduled:
|
|
summary: Triggered by Scheduled Search
|
|
value:
|
|
scheduleId: 7a724640-0c17-4ce9-a8c3-4a89738459c8
|
|
test:
|
|
summary: Triggered by UI Test
|
|
value:
|
|
owner:
|
|
type: IDENTITY
|
|
id: 2c91808568c529c60168cca6f90c1313
|
|
recipients:
|
|
- type: IDENTITY
|
|
id: 2c91808568c529c60168cca6f90c1313
|
|
required: true
|
|
responses:
|
|
'202':
|
|
description: Accepted - Returned if the request was successfully accepted into the system.
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document.
|
|
$SearchArguments = @"
|
|
{
|
|
"owner" : "",
|
|
"recipients" : [ {
|
|
"id" : "2c91808568c529c60168cca6f90c1313",
|
|
"type" : "IDENTITY"
|
|
}, {
|
|
"id" : "2c91808568c529c60168cca6f90c1313",
|
|
"type" : "IDENTITY"
|
|
} ],
|
|
"scheduleId" : "7a724640-0c17-4ce9-a8c3-4a89738459c8"
|
|
}
|
|
"@
|
|
|
|
# Execute a saved search by ID
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToSearchArguments -Json $SearchArguments
|
|
Invoke-ExecuteSavedSearch-Id $Id -SearchArguments $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Invoke-ExecuteSavedSearch -Id $Id -SearchArguments $SearchArguments
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-ExecuteSavedSearch"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/scheduled-searches:
|
|
post:
|
|
tags:
|
|
- Scheduled Search
|
|
description: |
|
|
Creates a new scheduled search.
|
|
summary: Create a new scheduled search
|
|
operationId: createScheduledSearch
|
|
requestBody:
|
|
description: The scheduled search to persist.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/components/schemas/ScheduledSearch/allOf/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/scheduled/ScheduledSearchName.yaml
|
|
- $ref: '#/components/schemas/ScheduledSearch/allOf/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/scheduled/SearchSchedule.yaml
|
|
examples:
|
|
Daily Search:
|
|
description: A search that executes each day at a 9 AM
|
|
value:
|
|
savedSearchId: 9c620e13-cd33-4804-a13d-403bd7bcdbad
|
|
schedule:
|
|
type: DAILY
|
|
hours:
|
|
type: LIST
|
|
values:
|
|
- '9'
|
|
recipients:
|
|
- type: IDENTITY
|
|
id: 2c9180867624cbd7017642d8c8c81f67
|
|
Weekly Search:
|
|
description: A search that executes each week on select days and times
|
|
value:
|
|
savedSearchId: 9c620e13-cd33-4804-a13d-403bd7bcdbad
|
|
schedule:
|
|
type: WEEKLY
|
|
days:
|
|
type: LIST
|
|
values:
|
|
- MON
|
|
- TUE
|
|
- WED
|
|
- THU
|
|
- FRI
|
|
- SAT
|
|
- SUN
|
|
hours:
|
|
type: LIST
|
|
values:
|
|
- '9'
|
|
recipients:
|
|
- type: IDENTITY
|
|
id: 2c9180867624cbd7017642d8c8c81f67
|
|
Monthly Search:
|
|
description: A search that executes each month on select days and times
|
|
value:
|
|
savedSearchId: 9c620e13-cd33-4804-a13d-403bd7bcdbad
|
|
schedule:
|
|
type: MONTHLY
|
|
days:
|
|
type: LIST
|
|
values:
|
|
- '1'
|
|
- '7'
|
|
- '14'
|
|
- L
|
|
hours:
|
|
type: LIST
|
|
values:
|
|
- '9'
|
|
recipients:
|
|
- type: IDENTITY
|
|
id: 2c9180867624cbd7017642d8c8c81f67
|
|
Annual Search:
|
|
description: A search that executes each year on the defined months, days, and times.
|
|
value:
|
|
savedSearchId: 9c620e13-cd33-4804-a13d-403bd7bcdbad
|
|
schedule:
|
|
type: ANNUALLY
|
|
months:
|
|
type: LIST
|
|
values:
|
|
- '1'
|
|
interval: 3
|
|
days:
|
|
type: LIST
|
|
values:
|
|
- '1'
|
|
- '7'
|
|
- '14'
|
|
- L
|
|
hours:
|
|
type: LIST
|
|
values:
|
|
- '9'
|
|
recipients:
|
|
- type: IDENTITY
|
|
id: 2c9180867624cbd7017642d8c8c81f67
|
|
Calendar Search:
|
|
description: A search that executes on specific calendar days
|
|
value:
|
|
savedSearchId: 9c620e13-cd33-4804-a13d-403bd7bcdbad
|
|
schedule:
|
|
type: CALENDAR
|
|
days:
|
|
type: LIST
|
|
values:
|
|
- '2023-01-22'
|
|
- '2023-02-22'
|
|
hours:
|
|
type: LIST
|
|
values:
|
|
- '9'
|
|
recipients:
|
|
- type: IDENTITY
|
|
id: 2c9180867624cbd7017642d8c8c81f67
|
|
required: true
|
|
responses:
|
|
'201':
|
|
description: The persisted scheduled search.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
allOf:
|
|
- type: object
|
|
properties:
|
|
id:
|
|
description: The scheduled search ID.
|
|
type: string
|
|
example: 0de46054-fe90-434a-b84e-c6b3359d0c64
|
|
readOnly: true
|
|
owner:
|
|
description: The owner of the scheduled search
|
|
readOnly: true
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: The type of object being referenced
|
|
enum:
|
|
- IDENTITY
|
|
example: IDENTITY
|
|
id:
|
|
type: string
|
|
description: The ID of the referenced object
|
|
example: 2c9180867624cbd7017642d8c8c81f67
|
|
required:
|
|
- type
|
|
- id
|
|
ownerId:
|
|
description: |
|
|
The ID of the scheduled search owner.
|
|
|
|
Please use the `id` in the `owner` object instead.
|
|
type: string
|
|
example: 2c9180867624cbd7017642d8c8c81f67
|
|
readOnly: true
|
|
deprecated: true
|
|
- $ref: '#/components/schemas/ScheduledSearch/allOf/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/scheduled/ScheduledSearchName.yaml
|
|
- $ref: '#/components/schemas/ScheduledSearch/allOf/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/scheduled/SearchSchedule.yaml
|
|
required:
|
|
- id
|
|
- owner
|
|
- ownerId
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$CreateScheduledSearchRequest = @"
|
|
{savedSearchId=9c620e13-cd33-4804-a13d-403bd7bcdbad, schedule={type=DAILY, hours={type=LIST, values=[9]}}, recipients=[{type=IDENTITY, id=2c9180867624cbd7017642d8c8c81f67}]}
|
|
"@
|
|
|
|
# Create a new scheduled search
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToCreateScheduledSearchRequest -Json $CreateScheduledSearchRequest
|
|
New-ScheduledSearch-CreateScheduledSearchRequest $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# New-ScheduledSearch -CreateScheduledSearchRequest $CreateScheduledSearchRequest
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ScheduledSearch"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
get:
|
|
tags:
|
|
- Scheduled Search
|
|
description: |
|
|
Returns a list of scheduled searches.
|
|
summary: List scheduled searches
|
|
operationId: listScheduledSearch
|
|
parameters:
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
- name: filters
|
|
in: query
|
|
schema:
|
|
type: string
|
|
description: |-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
**owner.id**: *eq*
|
|
|
|
**savedSearchId**: *eq*
|
|
example: savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"
|
|
responses:
|
|
'200':
|
|
description: The list of requested scheduled searches.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1scheduled-searches/post/responses/201/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/scheduled/ScheduledSearch.yaml
|
|
headers:
|
|
X-Total-Count:
|
|
description: The total result count (returned only if the *count* parameter is specified as *true*).
|
|
schema:
|
|
type: integer
|
|
example: 5
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
$Filters = "savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* **savedSearchId**: *eq* (optional)
|
|
|
|
# List scheduled searches
|
|
|
|
try {
|
|
Get-ScheduledSearch
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-ScheduledSearch -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ScheduledSearch"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/scheduled-searches/{id}:
|
|
put:
|
|
tags:
|
|
- Scheduled Search
|
|
description: |
|
|
Updates an existing scheduled search.
|
|
summary: Update an existing Scheduled Search
|
|
operationId: updateScheduledSearch
|
|
parameters:
|
|
- $ref: '#/paths/~1saved-searches~1%7Bid%7D/put/parameters/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/path/search/id.yaml
|
|
requestBody:
|
|
description: The scheduled search to persist.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1scheduled-searches/post/responses/201/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/scheduled/ScheduledSearch.yaml
|
|
required: true
|
|
responses:
|
|
'200':
|
|
description: The persisted scheduled search.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1scheduled-searches/post/responses/201/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/scheduled/ScheduledSearch.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document.
|
|
$ScheduledSearch = @"
|
|
{
|
|
"owner" : {
|
|
"id" : "2c9180867624cbd7017642d8c8c81f67",
|
|
"type" : "IDENTITY"
|
|
},
|
|
"displayQueryDetails" : false,
|
|
"created" : "",
|
|
"description" : "Daily disabled accounts",
|
|
"ownerId" : "2c9180867624cbd7017642d8c8c81f67",
|
|
"enabled" : false,
|
|
"schedule" : {
|
|
"hours" : {
|
|
"values" : [ "MON", "WED" ],
|
|
"interval" : 3,
|
|
"type" : "LIST"
|
|
},
|
|
"months" : {
|
|
"values" : [ "MON", "WED" ],
|
|
"interval" : 3,
|
|
"type" : "LIST"
|
|
},
|
|
"timeZoneId" : "America/Chicago",
|
|
"days" : {
|
|
"values" : [ "MON", "WED" ],
|
|
"interval" : 3,
|
|
"type" : "LIST"
|
|
},
|
|
"expiration" : "2018-06-25T20:22:28.104Z",
|
|
"type" : "WEEKLY"
|
|
},
|
|
"recipients" : [ {
|
|
"id" : "2c9180867624cbd7017642d8c8c81f67",
|
|
"type" : "IDENTITY"
|
|
}, {
|
|
"id" : "2c9180867624cbd7017642d8c8c81f67",
|
|
"type" : "IDENTITY"
|
|
} ],
|
|
"savedSearchId" : "554f1511-f0a1-4744-ab14-599514d3e57c",
|
|
"name" : "Daily disabled accounts",
|
|
"modified" : "",
|
|
"id" : "0de46054-fe90-434a-b84e-c6b3359d0c64",
|
|
"emailEmptyResults" : false
|
|
}
|
|
"@
|
|
|
|
# Update an existing Scheduled Search
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToScheduledSearch -Json $ScheduledSearch
|
|
Update-ScheduledSearch-Id $Id -ScheduledSearch $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Update-ScheduledSearch -Id $Id -ScheduledSearch $ScheduledSearch
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ScheduledSearch"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
get:
|
|
tags:
|
|
- Scheduled Search
|
|
description: Returns the specified scheduled search.
|
|
summary: Get a Scheduled Search
|
|
operationId: getScheduledSearch
|
|
parameters:
|
|
- $ref: '#/paths/~1saved-searches~1%7Bid%7D/put/parameters/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/path/search/id.yaml
|
|
responses:
|
|
'200':
|
|
description: The requested scheduled search.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1scheduled-searches/post/responses/201/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/scheduled/ScheduledSearch.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document.
|
|
|
|
# Get a Scheduled Search
|
|
|
|
try {
|
|
Get-ScheduledSearch-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-ScheduledSearch -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ScheduledSearch"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
delete:
|
|
tags:
|
|
- Scheduled Search
|
|
description: |
|
|
Deletes the specified scheduled search.
|
|
operationId: deleteScheduledSearch
|
|
summary: Delete a Scheduled Search
|
|
parameters:
|
|
- $ref: '#/paths/~1saved-searches~1%7Bid%7D/put/parameters/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/path/search/id.yaml
|
|
responses:
|
|
'204':
|
|
description: No Content - Indicates the request was successful but there is no content to be returned in the response.
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document.
|
|
|
|
# Delete a Scheduled Search
|
|
|
|
try {
|
|
Remove-ScheduledSearch-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Remove-ScheduledSearch -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ScheduledSearch"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/scheduled-searches/{id}/unsubscribe:
|
|
post:
|
|
tags:
|
|
- Scheduled Search
|
|
description: |
|
|
Unsubscribes a recipient from the specified scheduled search.
|
|
operationId: unsubscribeScheduledSearch
|
|
summary: Unsubscribe a recipient from Scheduled Search
|
|
parameters:
|
|
- $ref: '#/paths/~1saved-searches~1%7Bid%7D/put/parameters/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/path/search/id.yaml
|
|
requestBody:
|
|
description: |
|
|
The recipient to be removed from the scheduled search.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/SavedSearch/allOf/0/properties/owner'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/TypedReference.yaml
|
|
required: true
|
|
responses:
|
|
'204':
|
|
description: No Content - Indicates the request was successful but there is no content to be returned in the response.
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document.
|
|
$TypedReference = @"
|
|
{
|
|
"id" : "2c91808568c529c60168cca6f90c1313",
|
|
"type" : "IDENTITY"
|
|
}
|
|
"@
|
|
|
|
# Unsubscribe a recipient from Scheduled Search
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToTypedReference -Json $TypedReference
|
|
Invoke-UnsubscribeScheduledSearch-Id $Id -TypedReference $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Invoke-UnsubscribeScheduledSearch -Id $Id -TypedReference $TypedReference
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-UnsubscribeScheduledSearch"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/search:
|
|
post:
|
|
tags:
|
|
- Search
|
|
description: 'Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging. '
|
|
externalDocs:
|
|
description: Learn more about search.
|
|
url: https://documentation.sailpoint.com/saas/help/search/index.html
|
|
operationId: searchPost
|
|
security:
|
|
- userAuth:
|
|
- sp:search:read
|
|
summary: Perform Search
|
|
parameters:
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- in: query
|
|
name: limit
|
|
description: |-
|
|
Max number of results to return.
|
|
See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
required: false
|
|
example: 10000
|
|
schema:
|
|
type: integer
|
|
format: int32
|
|
minimum: 0
|
|
maximum: 10000
|
|
default: 250
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
indices:
|
|
description: The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched.
|
|
externalDocs:
|
|
description: Learn more about search indices here.
|
|
url: https://documentation.sailpoint.com/saas/help/search/searchable-fields.html
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/SavedSearch/allOf/2/properties/indices/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/Index.yaml
|
|
example:
|
|
- identities
|
|
queryType:
|
|
description: |-
|
|
The type of query to use. By default, the `SAILPOINT` query type is used, which requires the `query` object to be defined in the request body.
|
|
To use the `queryDsl` or `typeAheadQuery` objects in the request, you must set the type to `DSL` or `TYPEAHEAD` accordingly.
|
|
Additional values may be added in the future without notice.
|
|
type: string
|
|
enum:
|
|
- DSL
|
|
- SAILPOINT
|
|
- TEXT
|
|
- TYPEAHEAD
|
|
default: SAILPOINT
|
|
example: SAILPOINT
|
|
queryVersion:
|
|
allOf:
|
|
- description: The current Elasticserver version.
|
|
type: string
|
|
default: '5.2'
|
|
example: '5.2'
|
|
- type: string
|
|
description: |-
|
|
The version of the query object.
|
|
This version number will map to the version of Elasticsearch for the query strings and objects being used.
|
|
query:
|
|
type: object
|
|
description: Query parameters used to construct an Elasticsearch query object.
|
|
properties:
|
|
query:
|
|
description: The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries.
|
|
type: string
|
|
example: name:a*
|
|
fields:
|
|
description: |-
|
|
The fields the query will be applied to. Fields provide you with a simple way to add additional fields to search, without making the query too complicated. For example, you can use the fields to specify that you want your query of "a*" to be applied to "name", "firstName", and the "source.name". The response will include all results matching the "a*" query found in those three fields.
|
|
A field's availability depends on the indices being searched. For example, if you are searching "identities", you can apply your search to the "firstName" field, but you couldn't use "firstName" with a search on "access profiles". Refer to the response schema for the respective lists of available fields.
|
|
type: string
|
|
example:
|
|
- firstName,lastName,email
|
|
timeZone:
|
|
description: The time zone to be applied to any range query related to dates.
|
|
type: string
|
|
example: America/Chicago
|
|
innerHit:
|
|
type: object
|
|
description: Inner Hit query object that will cause the specified nested type to be returned as the result matching the supplied query.
|
|
required:
|
|
- query
|
|
- type
|
|
properties:
|
|
query:
|
|
description: The search query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries.
|
|
type: string
|
|
example: source.name:\"Active Directory\"
|
|
type:
|
|
description: The nested type to use in the inner hits query. The nested type [Nested Type](https://www.elastic.co/guide/en/elasticsearch/reference/current/nested.html) refers to a document "nested" within another document. For example, an identity can have nested documents for access, accounts, and apps.
|
|
type: string
|
|
example: access
|
|
queryDsl:
|
|
description: The search query using the Elasticsearch [Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.10/query-dsl.html) syntax.
|
|
type: object
|
|
example:
|
|
match:
|
|
name: john.doe
|
|
textQuery:
|
|
type: object
|
|
description: Query parameters used to construct an Elasticsearch text query object.
|
|
required:
|
|
- terms
|
|
- fields
|
|
properties:
|
|
terms:
|
|
description: Words or characters that specify a particular thing to be searched for.
|
|
type: array
|
|
items:
|
|
type: string
|
|
example:
|
|
- The quick brown fox
|
|
- '3141592'
|
|
- '7'
|
|
fields:
|
|
description: The fields to be searched.
|
|
type: array
|
|
items:
|
|
type: string
|
|
example:
|
|
- displayName
|
|
- employeeNumber
|
|
- roleCount
|
|
matchAny:
|
|
description: Indicates that at least one of the terms must be found in the specified fields; otherwise, all terms must be found.
|
|
type: boolean
|
|
default: false
|
|
example: false
|
|
contains:
|
|
description: Indicates that the terms can be located anywhere in the specified fields; otherwise, the fields must begin with the terms.
|
|
type: boolean
|
|
default: false
|
|
example: true
|
|
typeAheadQuery:
|
|
type: object
|
|
description: 'Query parameters used to construct an Elasticsearch type ahead query object. The typeAheadQuery performs a search for top values beginning with the typed values. For example, typing "Jo" results in top hits matching "Jo." Typing "Job" results in top hits matching "Job." '
|
|
required:
|
|
- query
|
|
- field
|
|
properties:
|
|
query:
|
|
description: The type ahead query string used to construct a phrase prefix match query.
|
|
type: string
|
|
example: Work
|
|
field:
|
|
description: The field on which to perform the type ahead search.
|
|
type: string
|
|
example: source.name
|
|
nestedType:
|
|
description: The nested type.
|
|
type: string
|
|
example: access
|
|
maxExpansions:
|
|
description: |-
|
|
The number of suffixes the last term will be expanded into.
|
|
Influences the performance of the query and the number results returned.
|
|
Valid values: 1 to 1000.
|
|
type: integer
|
|
format: int32
|
|
minimum: 1
|
|
maximum: 1000
|
|
default: 10
|
|
example: 10
|
|
size:
|
|
description: The max amount of records the search will return.
|
|
type: integer
|
|
format: int32
|
|
minimum: 1
|
|
default: 100
|
|
example: 100
|
|
sort:
|
|
description: The sort order of the returned records.
|
|
type: string
|
|
default: desc
|
|
example: asc
|
|
sortByValue:
|
|
description: The flag that defines the sort type, by count or value.
|
|
type: boolean
|
|
default: false
|
|
example: true
|
|
includeNested:
|
|
description: Indicates whether nested objects from returned search results should be included.
|
|
type: boolean
|
|
default: true
|
|
example: true
|
|
queryResultFilter:
|
|
type: object
|
|
description: Allows the query results to be filtered by specifying a list of fields to include and/or exclude from the result documents.
|
|
properties:
|
|
includes:
|
|
description: The list of field names to include in the result documents.
|
|
type: array
|
|
items:
|
|
type: string
|
|
example:
|
|
- name
|
|
- displayName
|
|
excludes:
|
|
description: The list of field names to exclude from the result documents.
|
|
type: array
|
|
items:
|
|
type: string
|
|
example:
|
|
- stacktrace
|
|
aggregationType:
|
|
description: |
|
|
Enum representing the currently available query languages for aggregations, which are used to perform calculations or groupings on search results.
|
|
|
|
Additional values may be added in the future without notice.
|
|
type: string
|
|
enum:
|
|
- DSL
|
|
- SAILPOINT
|
|
default: DSL
|
|
example: DSL
|
|
aggregationsVersion:
|
|
allOf:
|
|
- $ref: '#/paths/~1search/post/requestBody/content/application~1json/schema/properties/queryVersion/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/ElasticVersion.yaml
|
|
- type: string
|
|
description: |-
|
|
The version of the language being used for aggregation queries.
|
|
This version number will map to the version of Elasticsearch for the aggregation query object.
|
|
aggregationsDsl:
|
|
description: The aggregation search query using Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) syntax.
|
|
type: object
|
|
example: {}
|
|
aggregations:
|
|
allOf:
|
|
- type: object
|
|
properties:
|
|
nested:
|
|
type: object
|
|
description: The nested aggregation object.
|
|
required:
|
|
- name
|
|
- type
|
|
properties:
|
|
name:
|
|
description: The name of the nested aggregate to be included in the result.
|
|
type: string
|
|
example: id
|
|
type:
|
|
description: The type of the nested object.
|
|
type: string
|
|
example: access
|
|
metric:
|
|
type: object
|
|
description: The calculation done on the results of the query
|
|
required:
|
|
- name
|
|
- field
|
|
properties:
|
|
name:
|
|
description: |-
|
|
The name of the metric aggregate to be included in the result.
|
|
If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results.
|
|
type: string
|
|
example: Access Name Count
|
|
type:
|
|
description: |-
|
|
Enum representing the currently supported metric aggregation types.
|
|
Additional values may be added in the future without notice.
|
|
type: string
|
|
enum:
|
|
- COUNT
|
|
- UNIQUE_COUNT
|
|
- AVG
|
|
- SUM
|
|
- MEDIAN
|
|
- MIN
|
|
- MAX
|
|
default: UNIQUE_COUNT
|
|
example: COUNT
|
|
field:
|
|
description: |
|
|
The field the calculation is performed on.
|
|
|
|
Prefix the field name with '@' to reference a nested object.
|
|
type: string
|
|
example: '@access.name'
|
|
filter:
|
|
type: object
|
|
description: An additional filter to constrain the results of the search query.
|
|
required:
|
|
- name
|
|
- field
|
|
- value
|
|
properties:
|
|
name:
|
|
description: The name of the filter aggregate to be included in the result.
|
|
type: string
|
|
example: Entitlements
|
|
type:
|
|
description: |-
|
|
Enum representing the currently supported filter aggregation types.
|
|
Additional values may be added in the future without notice.
|
|
type: string
|
|
enum:
|
|
- TERM
|
|
default: TERM
|
|
example: TERM
|
|
field:
|
|
description: |
|
|
The search field to apply the filter to.
|
|
|
|
Prefix the field name with '@' to reference a nested object.
|
|
type: string
|
|
example: access.type
|
|
value:
|
|
description: The value to filter on.
|
|
type: string
|
|
example: ENTITLEMENT
|
|
bucket:
|
|
type: object
|
|
description: The bucket to group the results of the aggregation query by.
|
|
required:
|
|
- name
|
|
- field
|
|
properties:
|
|
name:
|
|
description: The name of the bucket aggregate to be included in the result.
|
|
type: string
|
|
example: Identity Locations
|
|
type:
|
|
description: |-
|
|
Enum representing the currently supported bucket aggregation types.
|
|
Additional values may be added in the future without notice.
|
|
type: string
|
|
enum:
|
|
- TERMS
|
|
default: TERMS
|
|
example: TERMS
|
|
field:
|
|
description: |-
|
|
The field to bucket on.
|
|
Prefix the field name with '@' to reference a nested object.
|
|
type: string
|
|
example: attributes.city
|
|
size:
|
|
description: Maximum number of buckets to include.
|
|
type: integer
|
|
format: int32
|
|
example: 100
|
|
minDocCount:
|
|
description: Minimum number of documents a bucket should have.
|
|
type: integer
|
|
format: int32
|
|
example: 2
|
|
- type: object
|
|
properties:
|
|
subAggregation:
|
|
allOf:
|
|
- $ref: '#/paths/~1search/post/requestBody/content/application~1json/schema/properties/aggregations/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/aggregate/Aggregations.yaml
|
|
- type: object
|
|
properties:
|
|
subAggregation:
|
|
description: Aggregation to be performed on the result of the parent bucket aggregation.
|
|
$ref: '#/paths/~1search/post/requestBody/content/application~1json/schema/properties/aggregations/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/aggregate/Aggregations.yaml
|
|
sort:
|
|
description: The fields to be used to sort the search results. Use + or - to specify the sort direction.
|
|
type: array
|
|
items:
|
|
type: string
|
|
example:
|
|
- displayName
|
|
- +id
|
|
searchAfter:
|
|
description: |-
|
|
Used to begin the search window at the values specified.
|
|
This parameter consists of the last values of the sorted fields in the current record set.
|
|
This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value.
|
|
It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don't get duplicate results while paging.
|
|
For example, when searching for identities, if you are sorting by displayName you will also want to include ID, for example ["displayName", "id"].
|
|
If the last identity ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last displayName is "John Doe", then using that displayName and ID will start a new search after this identity.
|
|
The searchAfter value will look like ["John Doe","2c91808375d8e80a0175e1f88a575221"]
|
|
type: array
|
|
items:
|
|
type: string
|
|
example:
|
|
- John Doe
|
|
- 2c91808375d8e80a0175e1f88a575221
|
|
filters:
|
|
description: The filters to be applied for each filtered field name.
|
|
type: object
|
|
additionalProperties:
|
|
$ref: '#/components/schemas/SavedSearch/allOf/2/properties/filters/allOf/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/filter/Filter.yaml
|
|
example: {}
|
|
examples:
|
|
query-fields:
|
|
summary: Query with Fields
|
|
value:
|
|
indices:
|
|
- identities
|
|
query:
|
|
query: '"John Doe"'
|
|
fields:
|
|
- name
|
|
query-timeZone:
|
|
summary: Query with TimeZone
|
|
value:
|
|
indices:
|
|
- identities
|
|
query:
|
|
query: 'created: [2022-05-19T19:26:03.351Z TO now]'
|
|
timeZone: America/Los_Angeles
|
|
query-innerHit:
|
|
summary: Query with InnerHit
|
|
value:
|
|
indices:
|
|
- identities
|
|
query:
|
|
query: '"John Doe"'
|
|
innerHit:
|
|
type: access
|
|
query: source.name:\"Active Directory\"
|
|
typeAheadQuery:
|
|
summary: TypeAheadQuery
|
|
value:
|
|
indices:
|
|
- identities
|
|
queryType: TYPEAHEAD
|
|
typeAheadQuery:
|
|
field: name
|
|
query: Jo
|
|
maxExpansions: 50
|
|
size: 100
|
|
sort: desc
|
|
sortByValue: false
|
|
typeAheadQuery-nestedType:
|
|
summary: TypeAheadQuery with NestedType
|
|
value:
|
|
indices:
|
|
- identities
|
|
queryType: TYPEAHEAD
|
|
typeAheadQuery:
|
|
field: source.name
|
|
nestedType: access
|
|
query: Work
|
|
maxExpansions: 50
|
|
size: 100
|
|
sort: desc
|
|
sortByValue: false
|
|
filter-exists:
|
|
summary: Filter with Exists
|
|
value:
|
|
indices:
|
|
- identities
|
|
query:
|
|
query: attributes.city:London
|
|
filters:
|
|
attributes.cloudAuthoritativeSource:
|
|
type: EXISTS
|
|
exclude: true
|
|
filter-range:
|
|
summary: Filter with Range
|
|
value:
|
|
indices:
|
|
- identities
|
|
query:
|
|
query: attributes.city:London
|
|
timeZone: Europe/London
|
|
filters:
|
|
accessCount:
|
|
type: RANGE
|
|
range:
|
|
lower:
|
|
value: '3'
|
|
created:
|
|
type: RANGE
|
|
range:
|
|
lower:
|
|
value: '2019-12-01'
|
|
inclusive: true
|
|
upper:
|
|
value: '2020-01-01'
|
|
filter-terms:
|
|
summary: Filter with Terms
|
|
value:
|
|
indices:
|
|
- identities
|
|
query:
|
|
query: attributes.city:London
|
|
filters:
|
|
source.name:
|
|
type: TERMS
|
|
terms:
|
|
- HR Employees
|
|
- Corporate Active Directory
|
|
exclude: true
|
|
protected:
|
|
type: TERMS
|
|
terms:
|
|
- 'true'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
description: List of matching documents.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
oneOf:
|
|
- $ref: '#/components/schemas/SearchDocument/oneOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/access/profile/AccessProfileDocument.yaml
|
|
- $ref: '#/components/schemas/SearchDocument/oneOf/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/account/activity/AccountActivityDocument.yaml
|
|
- $ref: '#/components/schemas/SearchDocument/oneOf/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/entitlement/EntitlementDocument.yaml
|
|
- $ref: '#/components/schemas/SearchDocument/oneOf/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/event/EventDocument.yaml
|
|
- $ref: '#/components/schemas/SearchDocument/oneOf/4'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/identity/IdentityDocument.yaml
|
|
- $ref: '#/components/schemas/SearchDocument/oneOf/5'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/role/RoleDocument.yaml
|
|
examples:
|
|
accessProfiles:
|
|
summary: A collection of AccessProfiles
|
|
value:
|
|
- id: 2c9180825a6c1adc015a71c9023f0818
|
|
name: Cloud Eng
|
|
_type: accessprofile
|
|
description: Cloud Eng
|
|
created: '2017-02-24T20:21:23.145Z'
|
|
modified: '2019-05-24T20:36:04.312Z'
|
|
synced: '2020-02-18T05:30:20.414Z'
|
|
enabled: true
|
|
requestable: true
|
|
requestCommentsRequired: false
|
|
owner:
|
|
id: ff8081815757d36a015757d42e56031e
|
|
name: SailPoint Support
|
|
type: IDENTITY
|
|
email: cloud-support@sailpoint.com
|
|
source:
|
|
id: ff8081815757d4fb0157588f3d9d008f
|
|
name: Employees
|
|
entitlements:
|
|
- id: 2c918084575812550157589064f33b89
|
|
name: CN=Cloud Engineering,DC=sailpoint,DC=COM
|
|
description: mull
|
|
attribute: memberOf
|
|
value: CN=Cloud Engineering,DC=sailpoint,DC=COM
|
|
entitlementCount: 1
|
|
tags:
|
|
- TAG_1
|
|
- TAG_2
|
|
entitlements:
|
|
summary: A collection of Entitlements
|
|
value:
|
|
- id: 2c9180946ed0c43d016eec1a80892fbd
|
|
name: entitlement.aa415ae7
|
|
_type: entitlement
|
|
description: 'null'
|
|
attribute: groups
|
|
value: entitlement.aa415ae7
|
|
modified: '2019-12-09T19:19:50.154Z'
|
|
synced: '2020-02-19T04:30:32.906Z'
|
|
displayName: entitlement.aa415ae7
|
|
source:
|
|
id: 2c91808b6e9e6fb8016eec1a2b6f7b5f
|
|
name: ODS-HR-Employees
|
|
privileged: false
|
|
identityCount: 68
|
|
tags:
|
|
- TAG_1
|
|
- TAG_2
|
|
events:
|
|
summary: A collection of Events
|
|
value:
|
|
- id: e092842f-c904-4b59-aac8-2544abeeef4b
|
|
name: Update Task Schedule Passed
|
|
_type: event
|
|
created: '2020-02-17T16:23:18.327Z'
|
|
synced: '2020-02-17T16:23:18.388Z'
|
|
action: TASK_SCHEDULE_UPDATE_PASSED
|
|
type: SYSTEM_CONFIG
|
|
actor:
|
|
name: MantisTaskScheduler
|
|
target:
|
|
name: Perform provisioning activity search delete synchronization
|
|
stack: tpe
|
|
trackingNumber: c6b98bc39ece48b080826d16c76b166c
|
|
ipAddress: 207.189.160.158
|
|
details: 'null'
|
|
attributes:
|
|
sourceName: SailPoint
|
|
objects:
|
|
- TASK
|
|
- SCHEDULE
|
|
operation: UPDATE
|
|
status: PASSED
|
|
technicalName: TASK_SCHEDULE_UPDATE_PASSED
|
|
identities:
|
|
summary: A collection of Identities
|
|
value:
|
|
- id: 2c9180865c45e7e3015c46c434a80622
|
|
name: ad.admin
|
|
_type: identity
|
|
firstName: AD
|
|
lastName: Admin
|
|
displayName: AD Admin
|
|
email: SLPT.CLOUD.SAILPOINT.TEST+AD-ADMIN@GMAIL.COM
|
|
created: '2018-08-22T19:54:54.302Z'
|
|
modified: '2018-08-22T19:54:54.302Z'
|
|
synced: '2018-08-22T19:54:54.302Z'
|
|
phone: 512-942-7578
|
|
inactive: false
|
|
protected: false
|
|
status: UNREGISTERED
|
|
employeeNumber: O349804
|
|
manager: null
|
|
isManager: false
|
|
identityProfile:
|
|
id: 2c918085605c8d0601606f357cb231e6
|
|
name: E2E AD
|
|
source:
|
|
id: 2c9180855c45b230015c46c19b9c0202
|
|
name: EndToEnd-ADSource
|
|
attributes:
|
|
uid: ad.admin
|
|
firstname: AD
|
|
cloudAuthoritativeSource: 2c9180855c45b230015c46c19b9c0202
|
|
cloudStatus: UNREGISTERED
|
|
iplanet-am-user-alias-list: null
|
|
displayName: AD Admin
|
|
internalCloudStatus: UNREGISTERED
|
|
workPhone: 512-942-7578
|
|
email: SLPT.CLOUD.SAILPOINT.TEST+AD-ADMIN@GMAIL.COM
|
|
lastname: Admin
|
|
processingState: null
|
|
processingDetails: null
|
|
accounts:
|
|
- id: 2c9180865c45e7e3015c46c434a80623
|
|
name: ad.admin
|
|
accountId: CN=AD Admin,OU=slpt-automation,DC=TestAutomationAD,DC=local
|
|
source:
|
|
id: 2c9180855c45b230015c46c19b9c0202
|
|
name: EndToEnd-ADSource
|
|
type: Active Directory - Direct
|
|
disabled: false
|
|
locked: false
|
|
privileged: false
|
|
manuallyCorrelated: false
|
|
passwordLastSet: '2018-08-22T19:54:54.302Z'
|
|
entitlementAttributes:
|
|
memberOf:
|
|
- CN=Group Policy Creator Owners,CN=Users,DC=TestAutomationAD,DC=local
|
|
- CN=Domain Guests,CN=Users,DC=TestAutomationAD,DC=local
|
|
- CN=Domain Admins,CN=Users,DC=TestAutomationAD,DC=local
|
|
- CN=Enterprise Admins,CN=Users,DC=TestAutomationAD,DC=local
|
|
- CN=Schema Admins,CN=Users,DC=TestAutomationAD,DC=local
|
|
- CN=Guests,CN=Builtin,DC=TestAutomationAD,DC=local
|
|
- CN=Administrators,CN=Builtin,DC=TestAutomationAD,DC=local
|
|
created: '2018-08-22T19:54:54.302Z'
|
|
- id: 2c918083606d670c01606f35a30a0349
|
|
name: ad.admin
|
|
accountId: ad.admin
|
|
source:
|
|
id: ff8081815c46b85b015c46b90c7c02a6
|
|
name: IdentityNow
|
|
type: IdentityNowConnector
|
|
disabled: false
|
|
locked: false
|
|
privileged: false
|
|
manuallyCorrelated: false
|
|
passwordLastSet: null
|
|
entitlementAttributes: null
|
|
created: '2018-08-22T19:54:54.302Z'
|
|
accountCount: 2
|
|
apps:
|
|
- id: '22751'
|
|
name: ADP Workforce Now
|
|
source:
|
|
id: 2c9180855c45b230015c46e2f6a8026a
|
|
name: Corporate Active Directory
|
|
account:
|
|
id: 2c9180865c45efa4015c470be0de1606
|
|
accountId: CN=Bob Wilson,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com
|
|
appCount: 1
|
|
access:
|
|
- id: 2c918083634bc6cb01639808d40270ba
|
|
name: test [AccessProfile-1527264105448]
|
|
displayName: test
|
|
type: ACCESS_PROFILE
|
|
description: test
|
|
source:
|
|
id: 2c9180855c45b230015c46c19b9c0202
|
|
name: EndToEnd-ADSource
|
|
owner:
|
|
id: 2c9180865c45e7e3015c46c434a80622
|
|
name: ad.admin
|
|
displayName: AD Admin
|
|
- id: 2c9180865c45e7e3015c46c457c50755
|
|
name: Administrators
|
|
displayName: Administrators
|
|
type: ENTITLEMENT
|
|
description: null
|
|
source:
|
|
id: 2c9180855c45b230015c46c19b9c0202
|
|
name: EndToEnd-ADSource
|
|
privileged: false
|
|
attribute: memberOf
|
|
value: CN=Administrators,CN=Builtin,DC=TestAutomationAD,DC=local
|
|
standalone: false
|
|
- id: 2c9180865decdaa5015e06598b293108
|
|
name: test [cloudRole-1503345085223]
|
|
displayName: test
|
|
type: ROLE
|
|
description: test
|
|
owner:
|
|
id: 2c9180865c45e7e3015c46c5030707a0
|
|
name: will.albin
|
|
displayName: Albin Will
|
|
disabled: false
|
|
accessCount: 3
|
|
accessProfileCount: 1
|
|
entitlementCount: 1
|
|
roleCount: 1
|
|
tags:
|
|
- TAG_1
|
|
- TAG_2
|
|
roles:
|
|
summary: A collection of Roles
|
|
value:
|
|
- id: 2c91808c6faadea6016fb4f2bc69077b
|
|
name: IT Role
|
|
_type: role
|
|
description: IT role
|
|
created: '2020-01-17T19:20:15.040Z'
|
|
modified: null
|
|
synced: '2020-02-18T05:30:20.145Z'
|
|
enabled: true
|
|
requestable: false
|
|
requestCommentsRequired: false
|
|
owner:
|
|
id: 2c9180a46faadee4016fb4e018c20639
|
|
name: Cloud Support
|
|
type: IDENTITY
|
|
email: thomas.edison@acme-solar.com
|
|
accessProfiles:
|
|
- id: 2c91809c6faade77016fb4f0b63407ae
|
|
name: Admin Access
|
|
accessProfileCount: 1
|
|
tags:
|
|
- TAG_1
|
|
- TAG_2
|
|
headers:
|
|
X-Total-Count:
|
|
schema:
|
|
type: integer
|
|
description: The total result count (returned only if the *count* parameter is specified as *true*).
|
|
example: 30
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Search = @"
|
|
{
|
|
"queryDsl" : {
|
|
"match" : {
|
|
"name" : "john.doe"
|
|
}
|
|
},
|
|
"aggregationType" : "DSL",
|
|
"aggregationsVersion" : "",
|
|
"query" : {
|
|
"query" : "name:a*",
|
|
"timeZone" : "America/Chicago",
|
|
"fields" : "[firstName,lastName,email]",
|
|
"innerHit" : {
|
|
"query" : "source.name:\\\"Active Directory\\\"",
|
|
"type" : "access"
|
|
}
|
|
},
|
|
"aggregationsDsl" : { },
|
|
"sort" : [ "displayName", "+id" ],
|
|
"filters" : { },
|
|
"queryVersion" : "",
|
|
"queryType" : "SAILPOINT",
|
|
"includeNested" : true,
|
|
"queryResultFilter" : {
|
|
"excludes" : [ "stacktrace" ],
|
|
"includes" : [ "name", "displayName" ]
|
|
},
|
|
"indices" : [ "identities" ],
|
|
"typeAheadQuery" : {
|
|
"field" : "source.name",
|
|
"size" : 100,
|
|
"query" : "Work",
|
|
"sortByValue" : true,
|
|
"nestedType" : "access",
|
|
"sort" : "asc",
|
|
"maxExpansions" : 10
|
|
},
|
|
"textQuery" : {
|
|
"contains" : true,
|
|
"terms" : [ "The quick brown fox", "3141592", "7" ],
|
|
"matchAny" : false,
|
|
"fields" : [ "displayName", "employeeNumber", "roleCount" ]
|
|
},
|
|
"searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ],
|
|
"aggregations" : {
|
|
"filter" : {
|
|
"field" : "access.type",
|
|
"name" : "Entitlements",
|
|
"type" : "TERM",
|
|
"value" : "ENTITLEMENT"
|
|
},
|
|
"bucket" : {
|
|
"field" : "attributes.city",
|
|
"size" : 100,
|
|
"minDocCount" : 2,
|
|
"name" : "Identity Locations",
|
|
"type" : "TERMS"
|
|
},
|
|
"metric" : {
|
|
"field" : "@access.name",
|
|
"name" : "Access Name Count",
|
|
"type" : "COUNT"
|
|
},
|
|
"subAggregation" : {
|
|
"filter" : {
|
|
"field" : "access.type",
|
|
"name" : "Entitlements",
|
|
"type" : "TERM",
|
|
"value" : "ENTITLEMENT"
|
|
},
|
|
"bucket" : {
|
|
"field" : "attributes.city",
|
|
"size" : 100,
|
|
"minDocCount" : 2,
|
|
"name" : "Identity Locations",
|
|
"type" : "TERMS"
|
|
},
|
|
"metric" : {
|
|
"field" : "@access.name",
|
|
"name" : "Access Name Count",
|
|
"type" : "COUNT"
|
|
},
|
|
"subAggregation" : {
|
|
"filter" : {
|
|
"field" : "access.type",
|
|
"name" : "Entitlements",
|
|
"type" : "TERM",
|
|
"value" : "ENTITLEMENT"
|
|
},
|
|
"bucket" : {
|
|
"field" : "attributes.city",
|
|
"size" : 100,
|
|
"minDocCount" : 2,
|
|
"name" : "Identity Locations",
|
|
"type" : "TERMS"
|
|
},
|
|
"metric" : {
|
|
"field" : "@access.name",
|
|
"name" : "Access Name Count",
|
|
"type" : "COUNT"
|
|
},
|
|
"nested" : {
|
|
"name" : "id",
|
|
"type" : "access"
|
|
}
|
|
},
|
|
"nested" : {
|
|
"name" : "id",
|
|
"type" : "access"
|
|
}
|
|
},
|
|
"nested" : {
|
|
"name" : "id",
|
|
"type" : "access"
|
|
}
|
|
}
|
|
}
|
|
"@
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Limit = 10000 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
|
|
# Perform Search
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToSearch -Json $Search
|
|
Search-Post-Search $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Search-Post -Search $Search -Offset $Offset -Limit $Limit -Count $Count
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Post"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/search/count:
|
|
post:
|
|
tags:
|
|
- Search
|
|
description: Performs a search with a provided query and returns the count of results in the X-Total-Count header.
|
|
operationId: searchCount
|
|
security:
|
|
- userAuth:
|
|
- sp:search:read
|
|
summary: Count Documents Satisfying a Query
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1search/post/requestBody/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/Search.yaml
|
|
examples:
|
|
query-timeZone:
|
|
$ref: '#/paths/~1search/post/requestBody/content/application~1json/examples/query-timeZone'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/examples/query-timeZone.yaml
|
|
required: true
|
|
responses:
|
|
'204':
|
|
description: No content - indicates the request was successful but there is no content to be returned in the response.
|
|
headers:
|
|
X-Total-Count:
|
|
description: The total result count.
|
|
schema:
|
|
type: integer
|
|
example: 5
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Search = @"
|
|
{
|
|
"queryDsl" : {
|
|
"match" : {
|
|
"name" : "john.doe"
|
|
}
|
|
},
|
|
"aggregationType" : "DSL",
|
|
"aggregationsVersion" : "",
|
|
"query" : {
|
|
"query" : "name:a*",
|
|
"timeZone" : "America/Chicago",
|
|
"fields" : "[firstName,lastName,email]",
|
|
"innerHit" : {
|
|
"query" : "source.name:\\\"Active Directory\\\"",
|
|
"type" : "access"
|
|
}
|
|
},
|
|
"aggregationsDsl" : { },
|
|
"sort" : [ "displayName", "+id" ],
|
|
"filters" : { },
|
|
"queryVersion" : "",
|
|
"queryType" : "SAILPOINT",
|
|
"includeNested" : true,
|
|
"queryResultFilter" : {
|
|
"excludes" : [ "stacktrace" ],
|
|
"includes" : [ "name", "displayName" ]
|
|
},
|
|
"indices" : [ "identities" ],
|
|
"typeAheadQuery" : {
|
|
"field" : "source.name",
|
|
"size" : 100,
|
|
"query" : "Work",
|
|
"sortByValue" : true,
|
|
"nestedType" : "access",
|
|
"sort" : "asc",
|
|
"maxExpansions" : 10
|
|
},
|
|
"textQuery" : {
|
|
"contains" : true,
|
|
"terms" : [ "The quick brown fox", "3141592", "7" ],
|
|
"matchAny" : false,
|
|
"fields" : [ "displayName", "employeeNumber", "roleCount" ]
|
|
},
|
|
"searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ],
|
|
"aggregations" : {
|
|
"filter" : {
|
|
"field" : "access.type",
|
|
"name" : "Entitlements",
|
|
"type" : "TERM",
|
|
"value" : "ENTITLEMENT"
|
|
},
|
|
"bucket" : {
|
|
"field" : "attributes.city",
|
|
"size" : 100,
|
|
"minDocCount" : 2,
|
|
"name" : "Identity Locations",
|
|
"type" : "TERMS"
|
|
},
|
|
"metric" : {
|
|
"field" : "@access.name",
|
|
"name" : "Access Name Count",
|
|
"type" : "COUNT"
|
|
},
|
|
"subAggregation" : {
|
|
"filter" : {
|
|
"field" : "access.type",
|
|
"name" : "Entitlements",
|
|
"type" : "TERM",
|
|
"value" : "ENTITLEMENT"
|
|
},
|
|
"bucket" : {
|
|
"field" : "attributes.city",
|
|
"size" : 100,
|
|
"minDocCount" : 2,
|
|
"name" : "Identity Locations",
|
|
"type" : "TERMS"
|
|
},
|
|
"metric" : {
|
|
"field" : "@access.name",
|
|
"name" : "Access Name Count",
|
|
"type" : "COUNT"
|
|
},
|
|
"subAggregation" : {
|
|
"filter" : {
|
|
"field" : "access.type",
|
|
"name" : "Entitlements",
|
|
"type" : "TERM",
|
|
"value" : "ENTITLEMENT"
|
|
},
|
|
"bucket" : {
|
|
"field" : "attributes.city",
|
|
"size" : 100,
|
|
"minDocCount" : 2,
|
|
"name" : "Identity Locations",
|
|
"type" : "TERMS"
|
|
},
|
|
"metric" : {
|
|
"field" : "@access.name",
|
|
"name" : "Access Name Count",
|
|
"type" : "COUNT"
|
|
},
|
|
"nested" : {
|
|
"name" : "id",
|
|
"type" : "access"
|
|
}
|
|
},
|
|
"nested" : {
|
|
"name" : "id",
|
|
"type" : "access"
|
|
}
|
|
},
|
|
"nested" : {
|
|
"name" : "id",
|
|
"type" : "access"
|
|
}
|
|
}
|
|
}
|
|
"@
|
|
|
|
# Count Documents Satisfying a Query
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToSearch -Json $Search
|
|
Search-Count-Search $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Search-Count -Search $Search
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Count"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/search/aggregate:
|
|
post:
|
|
tags:
|
|
- Search
|
|
description: 'Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. '
|
|
operationId: searchAggregate
|
|
security:
|
|
- userAuth:
|
|
- sp:search:read
|
|
summary: Perform a Search Query Aggregation
|
|
parameters:
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1search/post/requestBody/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/Search.yaml
|
|
examples:
|
|
metricAggregation:
|
|
summary: MetricAggregation
|
|
value:
|
|
indices:
|
|
- identities
|
|
aggregationType: SAILPOINT
|
|
aggregations:
|
|
metric:
|
|
name: How Many Locations
|
|
type: UNIQUE_COUNT
|
|
field: attributes.city
|
|
metricAggregation-dsl:
|
|
summary: MetricAggregation using DSL
|
|
value:
|
|
indices:
|
|
- identities
|
|
aggregationType: DSL
|
|
aggregationsDsl:
|
|
How Many Locations:
|
|
cardinality:
|
|
field: attributes.city.exact
|
|
bucketAggregation:
|
|
summary: BucketAggregation
|
|
value:
|
|
indices:
|
|
- identities
|
|
aggregationType: SAILPOINT
|
|
aggregations:
|
|
bucket:
|
|
name: Identity Locations
|
|
type: TERMS
|
|
field: attributes.city
|
|
bucketAggregation-dsl:
|
|
summary: BucketAggregation using DSL
|
|
value:
|
|
indices:
|
|
- identities
|
|
aggregationType: DSL
|
|
aggregationsDsl:
|
|
Identity Locations:
|
|
terms:
|
|
field: attributes.city.exact
|
|
nestedAggregation-bucketAggregation:
|
|
summary: NestedAggregation with BucketAggregation
|
|
value:
|
|
indices:
|
|
- identities
|
|
aggregationType: SAILPOINT
|
|
aggregations:
|
|
nested:
|
|
name: Access
|
|
field: access
|
|
type: TERMS
|
|
bucket:
|
|
name: Access Source Name
|
|
type: TERMS
|
|
field: access.source.name
|
|
nestedAggregation-bucketAggregation-dsl:
|
|
summary: NestedAggregation with BucketAggregation using DSL
|
|
value:
|
|
indices:
|
|
- identities
|
|
aggregationType: DSL
|
|
aggregationsDsl:
|
|
access:
|
|
nested:
|
|
path: access
|
|
aggs:
|
|
Access Source Name:
|
|
terms:
|
|
field: access.source.name.exact
|
|
nestedAggregation-filterAggregation-bucketAggregation:
|
|
summary: NestedAggregation with FilterAggregation and BucketAggregation
|
|
value:
|
|
indices:
|
|
- identities
|
|
aggregationType: SAILPOINT
|
|
aggregations:
|
|
nested:
|
|
name: Access
|
|
field: access
|
|
type: TERMS
|
|
filter:
|
|
name: Entitlements
|
|
field: access.type
|
|
value: ENTITLEMENT
|
|
bucket:
|
|
name: Access Name
|
|
type: TERMS
|
|
field: access.name
|
|
nestedAggregation-filterAggregation-bucketAggregation-dsl:
|
|
summary: NestedAggregation with FilterAggregation and BucketAggregation using DSL
|
|
value:
|
|
indices:
|
|
- identities
|
|
aggregationType: DSL
|
|
aggregationsDsl:
|
|
access:
|
|
nested:
|
|
path: access
|
|
aggs:
|
|
Entitlements:
|
|
filter:
|
|
term:
|
|
access.type: ENTITLEMENT
|
|
aggs:
|
|
Access Name:
|
|
terms:
|
|
field: access.name.exact
|
|
bucketAggregation-subAggregation:
|
|
summary: BucketAggregation with SubAggregation
|
|
value:
|
|
indices:
|
|
- identities
|
|
aggregationType: SAILPOINT
|
|
aggregations:
|
|
bucket:
|
|
name: Identity Department
|
|
type: TERMS
|
|
field: attributes.department
|
|
subAggregation:
|
|
bucket:
|
|
name: Identity Locations
|
|
type: TERMS
|
|
field: attributes.city
|
|
bucketAggregation-subAggregation-dsl:
|
|
summary: BucketAggregation with SubAggregation using DSL
|
|
value:
|
|
indices:
|
|
- identities
|
|
aggregationType: DSL
|
|
aggregationsDsl:
|
|
Identity Department:
|
|
terms:
|
|
field: attributes.department.exact
|
|
aggs:
|
|
Identity Locations:
|
|
terms:
|
|
field: attributes.city.exact
|
|
required: true
|
|
responses:
|
|
'200':
|
|
description: Aggregation results.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
aggregations:
|
|
type: object
|
|
description: |
|
|
The document containing the results of the aggregation. This document is controlled by Elasticsearch and depends on the type of aggregation query that is run.
|
|
|
|
See Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) documentation for information.
|
|
example:
|
|
Identity Locations:
|
|
buckets:
|
|
- key: Austin
|
|
doc_count: 109
|
|
- key: London
|
|
doc_count: 64
|
|
- key: San Jose
|
|
doc_count: 27
|
|
- key: Brussels
|
|
doc_count: 26
|
|
- key: Sao Paulo
|
|
doc_count: 24
|
|
- key: Munich
|
|
doc_count: 23
|
|
- key: Singapore
|
|
doc_count: 22
|
|
- key: Tokyo
|
|
doc_count: 20
|
|
- key: Taipei
|
|
doc_count: 16
|
|
hits:
|
|
description: |
|
|
The results of the aggregation search query.
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1search/post/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/documents/SearchDocument.yaml
|
|
text/csv:
|
|
schema:
|
|
description: |
|
|
If the *Accept:text/csv* header is specified and the *aggregationType* parameter in the request body is *SAILPOINT*,
|
|
|
|
the aggregation result will be returned as a CSV document.
|
|
type: string
|
|
example:
|
|
- Identity Locations,Count
|
|
- Munich,23
|
|
- Brussels,26
|
|
- Singapore,22
|
|
- Tokyo,20
|
|
- Taipei,16
|
|
- London,64
|
|
- Austin,109
|
|
- Sao Paulo,24
|
|
- San Jose,27
|
|
headers:
|
|
X-Total-Count:
|
|
description: The total result count (returned only if the *count* parameter is specified as *true*).
|
|
schema:
|
|
type: integer
|
|
example: 5
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Search = @"
|
|
{
|
|
"queryDsl" : {
|
|
"match" : {
|
|
"name" : "john.doe"
|
|
}
|
|
},
|
|
"aggregationType" : "DSL",
|
|
"aggregationsVersion" : "",
|
|
"query" : {
|
|
"query" : "name:a*",
|
|
"timeZone" : "America/Chicago",
|
|
"fields" : "[firstName,lastName,email]",
|
|
"innerHit" : {
|
|
"query" : "source.name:\\\"Active Directory\\\"",
|
|
"type" : "access"
|
|
}
|
|
},
|
|
"aggregationsDsl" : { },
|
|
"sort" : [ "displayName", "+id" ],
|
|
"filters" : { },
|
|
"queryVersion" : "",
|
|
"queryType" : "SAILPOINT",
|
|
"includeNested" : true,
|
|
"queryResultFilter" : {
|
|
"excludes" : [ "stacktrace" ],
|
|
"includes" : [ "name", "displayName" ]
|
|
},
|
|
"indices" : [ "identities" ],
|
|
"typeAheadQuery" : {
|
|
"field" : "source.name",
|
|
"size" : 100,
|
|
"query" : "Work",
|
|
"sortByValue" : true,
|
|
"nestedType" : "access",
|
|
"sort" : "asc",
|
|
"maxExpansions" : 10
|
|
},
|
|
"textQuery" : {
|
|
"contains" : true,
|
|
"terms" : [ "The quick brown fox", "3141592", "7" ],
|
|
"matchAny" : false,
|
|
"fields" : [ "displayName", "employeeNumber", "roleCount" ]
|
|
},
|
|
"searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ],
|
|
"aggregations" : {
|
|
"filter" : {
|
|
"field" : "access.type",
|
|
"name" : "Entitlements",
|
|
"type" : "TERM",
|
|
"value" : "ENTITLEMENT"
|
|
},
|
|
"bucket" : {
|
|
"field" : "attributes.city",
|
|
"size" : 100,
|
|
"minDocCount" : 2,
|
|
"name" : "Identity Locations",
|
|
"type" : "TERMS"
|
|
},
|
|
"metric" : {
|
|
"field" : "@access.name",
|
|
"name" : "Access Name Count",
|
|
"type" : "COUNT"
|
|
},
|
|
"subAggregation" : {
|
|
"filter" : {
|
|
"field" : "access.type",
|
|
"name" : "Entitlements",
|
|
"type" : "TERM",
|
|
"value" : "ENTITLEMENT"
|
|
},
|
|
"bucket" : {
|
|
"field" : "attributes.city",
|
|
"size" : 100,
|
|
"minDocCount" : 2,
|
|
"name" : "Identity Locations",
|
|
"type" : "TERMS"
|
|
},
|
|
"metric" : {
|
|
"field" : "@access.name",
|
|
"name" : "Access Name Count",
|
|
"type" : "COUNT"
|
|
},
|
|
"subAggregation" : {
|
|
"filter" : {
|
|
"field" : "access.type",
|
|
"name" : "Entitlements",
|
|
"type" : "TERM",
|
|
"value" : "ENTITLEMENT"
|
|
},
|
|
"bucket" : {
|
|
"field" : "attributes.city",
|
|
"size" : 100,
|
|
"minDocCount" : 2,
|
|
"name" : "Identity Locations",
|
|
"type" : "TERMS"
|
|
},
|
|
"metric" : {
|
|
"field" : "@access.name",
|
|
"name" : "Access Name Count",
|
|
"type" : "COUNT"
|
|
},
|
|
"nested" : {
|
|
"name" : "id",
|
|
"type" : "access"
|
|
}
|
|
},
|
|
"nested" : {
|
|
"name" : "id",
|
|
"type" : "access"
|
|
}
|
|
},
|
|
"nested" : {
|
|
"name" : "id",
|
|
"type" : "access"
|
|
}
|
|
}
|
|
}
|
|
"@
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
|
|
# Perform a Search Query Aggregation
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToSearch -Json $Search
|
|
Search-Aggregate-Search $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Search-Aggregate -Search $Search -Offset $Offset -Limit $Limit -Count $Count
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Aggregate"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/search/{index}/{id}:
|
|
get:
|
|
tags:
|
|
- Search
|
|
description: Fetches a single document from the specified index, using the specified document ID.
|
|
operationId: searchGet
|
|
security:
|
|
- userAuth:
|
|
- sp:search:read
|
|
summary: Get a Document by ID
|
|
parameters:
|
|
- in: path
|
|
name: index
|
|
description: |
|
|
The index from which to fetch the specified document.
|
|
|
|
The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*.
|
|
schema:
|
|
type: string
|
|
enum:
|
|
- accessprofiles
|
|
- accountactivities
|
|
- entitlements
|
|
- events
|
|
- identities
|
|
- roles
|
|
required: true
|
|
example: accounts
|
|
- $ref: '#/paths/~1saved-searches~1%7Bid%7D/put/parameters/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/path/search/id.yaml
|
|
responses:
|
|
'200':
|
|
description: The requested document.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1search/post/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/documents/SearchDocument.yaml
|
|
examples:
|
|
accessProfile:
|
|
summary: AccessProfile
|
|
value:
|
|
id: 2c9180825a6c1adc015a71c9023f0818
|
|
name: Cloud Eng
|
|
description: Cloud Eng
|
|
created: '2017-02-24T20:21:23.145Z'
|
|
modified: '2019-05-24T20:36:04.312Z'
|
|
synced: '2020-02-18T05:30:20.414Z'
|
|
enabled: true
|
|
requestable: true
|
|
requestCommentsRequired: false
|
|
owner:
|
|
id: ff8081815757d36a015757d42e56031e
|
|
name: SailPoint Support
|
|
type: IDENTITY
|
|
email: cloud-support@sailpoint.com
|
|
source:
|
|
id: ff8081815757d4fb0157588f3d9d008f
|
|
name: Employees
|
|
entitlements:
|
|
- id: 2c918084575812550157589064f33b89
|
|
name: CN=Cloud Engineering,DC=sailpoint,DC=COM
|
|
description: mull
|
|
attribute: memberOf
|
|
value: CN=Cloud Engineering,DC=sailpoint,DC=COM
|
|
entitlementCount: 1
|
|
tags:
|
|
- TAG_1
|
|
- TAG_2
|
|
entitlement:
|
|
summary: Entitlement
|
|
value:
|
|
id: 2c9180946ed0c43d016eec1a80892fbd
|
|
name: entitlement.aa415ae7
|
|
description: 'null'
|
|
attribute: groups
|
|
value: entitlement.aa415ae7
|
|
modified: '2019-12-09T19:19:50.154Z'
|
|
created: '2018-12-07T01:07:48Z'
|
|
synced: '2020-02-19T04:30:32.906Z'
|
|
displayName: entitlement.aa415ae7
|
|
source:
|
|
id: 2c91808b6e9e6fb8016eec1a2b6f7b5f
|
|
name: ODS-HR-Employees
|
|
owner:
|
|
type: IDENTITY
|
|
id: 2c9180858315595501831958427e5424
|
|
name: Addie Lee
|
|
privileged: false
|
|
identityCount: 68
|
|
tags:
|
|
- TAG_1
|
|
- TAG_2
|
|
event:
|
|
summary: Event
|
|
value:
|
|
id: e092842f-c904-4b59-aac8-2544abeeef4b
|
|
name: Update Task Schedule Passed
|
|
created: '2020-02-17T16:23:18.327Z'
|
|
synced: '2020-02-17T16:23:18.388Z'
|
|
action: TASK_SCHEDULE_UPDATE_PASSED
|
|
type: SYSTEM_CONFIG
|
|
actor:
|
|
name: MantisTaskScheduler
|
|
target:
|
|
name: Perform provisioning activity search delete synchronization
|
|
stack: tpe
|
|
trackingNumber: c6b98bc39ece48b080826d16c76b166c
|
|
ipAddress: 207.189.160.158
|
|
details: 'null'
|
|
attributes:
|
|
sourceName: SailPoint
|
|
objects:
|
|
- TASK
|
|
- SCHEDULE
|
|
operation: UPDATE
|
|
status: PASSED
|
|
technicalName: TASK_SCHEDULE_UPDATE_PASSED
|
|
identity:
|
|
summary: Identity
|
|
value:
|
|
id: 2c9180865c45e7e3015c46c434a80622
|
|
name: ad.admin
|
|
firstName: AD
|
|
lastName: Admin
|
|
displayName: AD Admin
|
|
email: SLPT.CLOUD.SAILPOINT.TEST+AD-ADMIN@GMAIL.COM
|
|
created: '2018-08-22T19:54:54.302Z'
|
|
modified: '2018-08-22T19:54:54.302Z'
|
|
synced: '2018-08-22T19:54:54.302Z'
|
|
phone: 512-942-7578
|
|
inactive: false
|
|
protected: false
|
|
status: UNREGISTERED
|
|
employeeNumber: O349804
|
|
manager: null
|
|
isManager: false
|
|
identityProfile:
|
|
id: 2c918085605c8d0601606f357cb231e6
|
|
name: E2E AD
|
|
source:
|
|
id: 2c9180855c45b230015c46c19b9c0202
|
|
name: EndToEnd-ADSource
|
|
attributes:
|
|
uid: ad.admin
|
|
firstname: AD
|
|
cloudAuthoritativeSource: 2c9180855c45b230015c46c19b9c0202
|
|
cloudStatus: UNREGISTERED
|
|
iplanet-am-user-alias-list: null
|
|
displayName: AD Admin
|
|
internalCloudStatus: UNREGISTERED
|
|
workPhone: 512-942-7578
|
|
email: SLPT.CLOUD.SAILPOINT.TEST+AD-ADMIN@GMAIL.COM
|
|
lastname: Admin
|
|
processingState: null
|
|
processingDetails: null
|
|
accounts:
|
|
- id: 2c9180865c45e7e3015c46c434a80623
|
|
name: ad.admin
|
|
accountId: CN=AD Admin,OU=slpt-automation,DC=TestAutomationAD,DC=local
|
|
source:
|
|
id: 2c9180855c45b230015c46c19b9c0202
|
|
name: EndToEnd-ADSource
|
|
type: Active Directory - Direct
|
|
disabled: false
|
|
locked: false
|
|
privileged: false
|
|
manuallyCorrelated: false
|
|
passwordLastSet: '2018-08-22T19:54:54.302Z'
|
|
entitlementAttributes:
|
|
memberOf:
|
|
- CN=Group Policy Creator Owners,CN=Users,DC=TestAutomationAD,DC=local
|
|
- CN=Domain Guests,CN=Users,DC=TestAutomationAD,DC=local
|
|
- CN=Domain Admins,CN=Users,DC=TestAutomationAD,DC=local
|
|
- CN=Enterprise Admins,CN=Users,DC=TestAutomationAD,DC=local
|
|
- CN=Schema Admins,CN=Users,DC=TestAutomationAD,DC=local
|
|
- CN=Guests,CN=Builtin,DC=TestAutomationAD,DC=local
|
|
- CN=Administrators,CN=Builtin,DC=TestAutomationAD,DC=local
|
|
created: '2018-08-22T19:54:54.302Z'
|
|
- id: 2c918083606d670c01606f35a30a0349
|
|
name: ad.admin
|
|
accountId: ad.admin
|
|
source:
|
|
id: ff8081815c46b85b015c46b90c7c02a6
|
|
name: IdentityNow
|
|
type: IdentityNowConnector
|
|
disabled: false
|
|
locked: false
|
|
privileged: false
|
|
manuallyCorrelated: false
|
|
passwordLastSet: null
|
|
entitlementAttributes: null
|
|
created: '2018-08-22T19:54:54.302Z'
|
|
accountCount: 2
|
|
apps:
|
|
- id: '22751'
|
|
name: ADP Workforce Now
|
|
source:
|
|
id: 2c9180855c45b230015c46e2f6a8026a
|
|
name: Corporate Active Directory
|
|
account:
|
|
id: 2c9180865c45efa4015c470be0de1606
|
|
accountId: CN=Bob Wilson,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com
|
|
appCount: 1
|
|
access:
|
|
- id: 2c918083634bc6cb01639808d40270ba
|
|
name: test [AccessProfile-1527264105448]
|
|
displayName: test
|
|
type: ACCESS_PROFILE
|
|
description: test
|
|
source:
|
|
id: 2c9180855c45b230015c46c19b9c0202
|
|
name: EndToEnd-ADSource
|
|
owner:
|
|
id: 2c9180865c45e7e3015c46c434a80622
|
|
name: ad.admin
|
|
displayName: AD Admin
|
|
- id: 2c9180865c45e7e3015c46c457c50755
|
|
name: Administrators
|
|
displayName: Administrators
|
|
type: ENTITLEMENT
|
|
description: null
|
|
source:
|
|
id: 2c9180855c45b230015c46c19b9c0202
|
|
name: EndToEnd-ADSource
|
|
privileged: false
|
|
attribute: memberOf
|
|
value: CN=Administrators,CN=Builtin,DC=TestAutomationAD,DC=local
|
|
standalone: false
|
|
- id: 2c9180865decdaa5015e06598b293108
|
|
name: test [cloudRole-1503345085223]
|
|
displayName: test
|
|
type: ROLE
|
|
description: test
|
|
owner:
|
|
id: 2c9180865c45e7e3015c46c5030707a0
|
|
name: will.albin
|
|
displayName: Albin Will
|
|
disabled: false
|
|
accessCount: 3
|
|
accessProfileCount: 1
|
|
entitlementCount: 1
|
|
roleCount: 1
|
|
tags:
|
|
- TAG_1
|
|
- TAG_2
|
|
role:
|
|
summary: Role
|
|
value:
|
|
id: 2c91808c6faadea6016fb4f2bc69077b
|
|
name: IT Role
|
|
description: IT role
|
|
created: '2020-01-17T19:20:15.040Z'
|
|
modified: null
|
|
synced: '2020-02-18T05:30:20.145Z'
|
|
enabled: true
|
|
requestable: false
|
|
requestCommentsRequired: false
|
|
owner:
|
|
id: 2c9180a46faadee4016fb4e018c20639
|
|
name: Cloud Support
|
|
type: IDENTITY
|
|
email: thomas.edison@acme-solar.com
|
|
accessProfiles:
|
|
- id: 2c91809c6faade77016fb4f0b63407ae
|
|
name: Admin Access
|
|
accessProfileCount: 1
|
|
segments:
|
|
- id: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde
|
|
name: segment-xyz
|
|
description: This segment represents xyz
|
|
segmentCount: 1
|
|
entitlements:
|
|
- id: 2c91809c6faade77016fb4f0b63407ae
|
|
name: Admin Access
|
|
description: Access to everything
|
|
privileged: true
|
|
hasPermissions: true
|
|
entitlementCount: 1
|
|
tags:
|
|
- TAG_1
|
|
- TAG_2
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Index = "accessprofiles" # String | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*.
|
|
$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document.
|
|
|
|
# Get a Document by ID
|
|
|
|
try {
|
|
Search-Get-Index $Index -Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Search-Get -Index $Index -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Get"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/segments:
|
|
post:
|
|
operationId: createSegment
|
|
security:
|
|
- userAuth:
|
|
- idn:segment:manage
|
|
- applicationAuth:
|
|
- idn:segment:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
tags:
|
|
- Segments
|
|
summary: Create Segment
|
|
description: |-
|
|
This API creates a segment.
|
|
>**Note:** Segment definitions may take time to propagate to all identities.
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The segment's ID.
|
|
example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde
|
|
name:
|
|
type: string
|
|
description: The segment's business name.
|
|
example: segment-xyz
|
|
created:
|
|
type: string
|
|
format: date-time
|
|
description: The time when the segment is created.
|
|
example: '2020-01-01T00:00:00.000000Z'
|
|
modified:
|
|
type: string
|
|
format: date-time
|
|
description: The time when the segment is modified.
|
|
example: '2020-01-01T00:00:00.000000Z'
|
|
description:
|
|
type: string
|
|
description: The segment's optional description.
|
|
example: This segment represents xyz
|
|
owner:
|
|
type: object
|
|
nullable: true
|
|
description: The owner of this object.
|
|
properties:
|
|
type:
|
|
type: string
|
|
enum:
|
|
- IDENTITY
|
|
description: Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result.
|
|
example: IDENTITY
|
|
id:
|
|
type: string
|
|
description: Identity id
|
|
example: 2c9180a46faadee4016fb4e018c20639
|
|
name:
|
|
type: string
|
|
description: Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result.
|
|
example: support
|
|
visibilityCriteria:
|
|
allOf:
|
|
- type: object
|
|
properties:
|
|
expression:
|
|
type: object
|
|
properties:
|
|
operator:
|
|
type: string
|
|
description: Operator for the expression
|
|
enum:
|
|
- AND
|
|
- EQUALS
|
|
example: EQUALS
|
|
attribute:
|
|
type: string
|
|
description: Name for the attribute
|
|
example: location
|
|
nullable: true
|
|
value:
|
|
type: object
|
|
nullable: true
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: The type of attribute value
|
|
example: STRING
|
|
value:
|
|
type: string
|
|
description: The attribute value
|
|
example: Austin
|
|
children:
|
|
type: array
|
|
nullable: true
|
|
description: List of expressions
|
|
items:
|
|
type: object
|
|
properties:
|
|
operator:
|
|
type: string
|
|
description: Operator for the expression
|
|
enum:
|
|
- AND
|
|
- EQUALS
|
|
example: EQUALS
|
|
attribute:
|
|
type: string
|
|
description: Name for the attribute
|
|
example: location
|
|
nullable: true
|
|
value:
|
|
$ref: '#/paths/~1segments/post/requestBody/content/application~1json/schema/properties/visibilityCriteria/allOf/0/properties/expression/properties/value'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/Value.yaml
|
|
children:
|
|
type: string
|
|
nullable: true
|
|
description: There cannot be anymore nested children. This will always be null.
|
|
example: null
|
|
example: []
|
|
- nullable: true
|
|
active:
|
|
type: boolean
|
|
description: This boolean indicates whether the segment is currently active. Inactive segments have no effect.
|
|
default: false
|
|
example: true
|
|
responses:
|
|
'201':
|
|
description: Segment created
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1segments/post/requestBody/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/Segment.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Segment = @"
|
|
{
|
|
"owner" : {
|
|
"name" : "support",
|
|
"id" : "2c9180a46faadee4016fb4e018c20639",
|
|
"type" : "IDENTITY"
|
|
},
|
|
"created" : "2020-01-01T00:00:00Z",
|
|
"visibilityCriteria" : {
|
|
"expression" : {
|
|
"children" : [ ],
|
|
"attribute" : "location",
|
|
"value" : {
|
|
"type" : "STRING",
|
|
"value" : "Austin"
|
|
},
|
|
"operator" : "EQUALS"
|
|
}
|
|
},
|
|
"name" : "segment-xyz",
|
|
"modified" : "2020-01-01T00:00:00Z",
|
|
"description" : "This segment represents xyz",
|
|
"active" : true,
|
|
"id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"
|
|
}
|
|
"@
|
|
|
|
# Create Segment
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToSegment -Json $Segment
|
|
New-Segment-Segment $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# New-Segment -Segment $Segment
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Segment"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
get:
|
|
operationId: listSegments
|
|
security:
|
|
- userAuth:
|
|
- idn:segment:read
|
|
- idn:segment:manage
|
|
- applicationAuth:
|
|
- idn:segment:read
|
|
- idn:segment:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
tags:
|
|
- Segments
|
|
summary: List Segments
|
|
description: 'This API returns a list of all segments. '
|
|
parameters:
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
responses:
|
|
'200':
|
|
description: List of all segments
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1segments/post/requestBody/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/Segment.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
|
|
# List Segments
|
|
|
|
try {
|
|
Get-Segments
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-Segments -Limit $Limit -Offset $Offset -Count $Count
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Segments"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/segments/{id}:
|
|
get:
|
|
operationId: getSegment
|
|
security:
|
|
- userAuth:
|
|
- idn:segment:read
|
|
- idn:segment:manage
|
|
- applicationAuth:
|
|
- idn:segment:read
|
|
- idn:segment:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
tags:
|
|
- Segments
|
|
summary: Get Segment by ID
|
|
description: This API returns the segment specified by the given ID.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listSegments
|
|
description: The segment ID to retrieve.
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
responses:
|
|
'200':
|
|
description: Segment
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1segments/post/requestBody/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/Segment.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve.
|
|
|
|
# Get Segment by ID
|
|
|
|
try {
|
|
Get-Segment-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-Segment -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Segment"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
delete:
|
|
operationId: deleteSegment
|
|
security:
|
|
- userAuth:
|
|
- idn:segment:manage
|
|
- applicationAuth:
|
|
- idn:segment:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
tags:
|
|
- Segments
|
|
summary: Delete Segment by ID
|
|
description: |-
|
|
This API deletes the segment specified by the given ID.
|
|
>**Note:** that segment deletion may take some time to become effective.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listSegments
|
|
description: The segment ID to delete.
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
responses:
|
|
'204':
|
|
description: No content.
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete.
|
|
|
|
# Delete Segment by ID
|
|
|
|
try {
|
|
Remove-Segment-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Remove-Segment -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Segment"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
patch:
|
|
operationId: patchSegment
|
|
security:
|
|
- userAuth:
|
|
- idn:segment:manage
|
|
- applicationAuth:
|
|
- idn:segment:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
tags:
|
|
- Segments
|
|
summary: Update Segment
|
|
description: |-
|
|
Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
>**Note:** Changes to a segment may take some time to propagate to all identities.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listSegments
|
|
description: The segment ID to modify.
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
requestBody:
|
|
required: true
|
|
description: |
|
|
A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
|
|
The following fields are patchable:
|
|
* name
|
|
* description
|
|
* owner
|
|
* visibilityCriteria
|
|
* active
|
|
content:
|
|
application/json-patch+json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
examples:
|
|
Set Visibility Criteria:
|
|
description: Set the visibility criteria
|
|
value:
|
|
- op: replace
|
|
path: /visibilityCriteria
|
|
value:
|
|
expression:
|
|
operator: AND
|
|
children:
|
|
- operator: EQUALS
|
|
attribute: location
|
|
value:
|
|
type: STRING
|
|
value: Philadelphia
|
|
- operator: EQUALS
|
|
attribute: department
|
|
value:
|
|
type: STRING
|
|
value: HR
|
|
responses:
|
|
'200':
|
|
description: Indicates the PATCH operation succeeded, and returns the segment's new representation.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1segments/post/requestBody/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/Segment.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to modify.
|
|
$RequestBody = # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active
|
|
$RequestBody = @"[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@
|
|
|
|
|
|
# Update Segment
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
|
|
Update-Segment-Id $Id -RequestBody $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Update-Segment -Id $Id -RequestBody $RequestBody
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Segment"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/service-desk-integrations:
|
|
get:
|
|
tags:
|
|
- Service Desk Integration
|
|
summary: List existing Service Desk integrations
|
|
description: Get a list of Service Desk integration objects.
|
|
operationId: getServiceDeskIntegrations
|
|
parameters:
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- name: sorters
|
|
in: query
|
|
required: false
|
|
style: form
|
|
explode: true
|
|
schema:
|
|
type: string
|
|
description: |-
|
|
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
|
|
|
Sorting is supported for the following fields: **name**
|
|
example: name
|
|
- name: filters
|
|
in: query
|
|
required: false
|
|
style: form
|
|
explode: true
|
|
schema:
|
|
type: string
|
|
format: comma-separated
|
|
description: |-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
**id**: *eq, in*
|
|
|
|
**name**: *eq*
|
|
|
|
**type**: *eq, in*
|
|
|
|
**cluster**: *eq, in*
|
|
example: name eq "John Doe"
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
responses:
|
|
'200':
|
|
description: List of ServiceDeskIntegrationDto
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
allOf:
|
|
- type: object
|
|
description: Service Desk integration's specification.
|
|
required:
|
|
- name
|
|
- description
|
|
- type
|
|
- attributes
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: Unique identifier for the Service Desk integration
|
|
example: 62945a496ef440189b1f03e3623411c8
|
|
name:
|
|
description: Service Desk integration's name. The name must be unique.
|
|
type: string
|
|
example: Service Desk Integration Name
|
|
created:
|
|
type: string
|
|
format: date-time
|
|
description: The date and time the Service Desk integration was created
|
|
example: '2024-01-17T18:45:25.994Z'
|
|
modified:
|
|
type: string
|
|
format: date-time
|
|
description: The date and time the Service Desk integration was last modified
|
|
example: '2024-02-18T18:45:25.994Z'
|
|
description:
|
|
description: Service Desk integration's description.
|
|
type: string
|
|
example: A very nice Service Desk integration
|
|
type:
|
|
description: |
|
|
Service Desk integration types:
|
|
|
|
- ServiceNowSDIM
|
|
- ServiceNow
|
|
type: string
|
|
default: ServiceNowSDIM
|
|
example: ServiceNowSDIM
|
|
ownerRef:
|
|
allOf:
|
|
- $ref: '#/components/schemas/ServiceDeskIntegrationDto/allOf/0/properties/ownerRef/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/OwnerDto.yaml
|
|
clusterRef:
|
|
allOf:
|
|
- $ref: '#/components/schemas/ServiceDeskIntegrationDto/allOf/0/properties/clusterRef/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/SourceClusterDto.yaml
|
|
cluster:
|
|
description: Cluster ID for the Service Desk integration (replaced by clusterRef, retained for backward compatibility).
|
|
type: string
|
|
example: xyzzy999
|
|
deprecated: true
|
|
nullable: true
|
|
managedSources:
|
|
description: Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility).
|
|
type: array
|
|
items:
|
|
type: string
|
|
deprecated: true
|
|
example:
|
|
- 2c9180835d191a86015d28455b4a2329
|
|
- 2c5680835d191a85765d28455b4a9823
|
|
provisioningConfig:
|
|
description: The 'provisioningConfig' property specifies the configuration used to provision integrations.
|
|
$ref: '#/components/schemas/ServiceDeskIntegrationDto/allOf/0/properties/provisioningConfig'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ProvisioningConfig.yaml
|
|
attributes:
|
|
description: Service Desk integration's attributes. Validation constraints enforced by the implementation.
|
|
type: object
|
|
additionalProperties: true
|
|
example:
|
|
property: value
|
|
key: value
|
|
beforeProvisioningRule:
|
|
allOf:
|
|
- $ref: '#/components/schemas/ServiceDeskIntegrationDto/allOf/0/properties/beforeProvisioningRule/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/BeforeProvisioningRuleDto.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:service-desk-integration:read
|
|
- idn:service-desk-integration:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional)
|
|
$Filters = "name eq "John Doe"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
|
|
# List existing Service Desk integrations
|
|
|
|
try {
|
|
Get-ServiceDeskIntegrations
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-ServiceDeskIntegrations -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegrations"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
post:
|
|
tags:
|
|
- Service Desk Integration
|
|
summary: Create new Service Desk integration
|
|
description: Create a new Service Desk integration.
|
|
operationId: createServiceDeskIntegration
|
|
requestBody:
|
|
description: The specifics of a new integration to create
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1service-desk-integrations/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ServiceDeskIntegrationDto.yaml
|
|
required: true
|
|
responses:
|
|
'200':
|
|
description: Details of the created integration
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1service-desk-integrations/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ServiceDeskIntegrationDto.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:service-desk-integration:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$ServiceDeskIntegrationDto = @"
|
|
{
|
|
"ownerRef" : "",
|
|
"cluster" : "xyzzy999",
|
|
"created" : "2024-01-17T18:45:25.994Z",
|
|
"description" : "A very nice Service Desk integration",
|
|
"clusterRef" : "",
|
|
"type" : "ServiceNowSDIM",
|
|
"managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ],
|
|
"provisioningConfig" : {
|
|
"managedResourceRefs" : [ {
|
|
"type" : "SOURCE",
|
|
"id" : "2c9180855d191c59015d291ceb051111",
|
|
"name" : "My Source 1"
|
|
}, {
|
|
"type" : "SOURCE",
|
|
"id" : "2c9180855d191c59015d291ceb052222",
|
|
"name" : "My Source 2"
|
|
} ],
|
|
"provisioningRequestExpiration" : 7,
|
|
"noProvisioningRequests" : true,
|
|
"universalManager" : true,
|
|
"planInitializerScript" : {
|
|
"source" : "<?xml version='1.0' encoding='UTF-8'?>\\r\\n<!DOCTYPE Rule PUBLIC \\\"sailpoint.dtd\\\" \\\"sailpoint.dtd\\\">\\r\\n<Rule name=\\\"Example Rule\\\" type=\\\"BeforeProvisioning\\\">\\r\\n <Description>Before Provisioning Rule which changes disables and enables to a modify.</Description>\\r\\n <Source><![CDATA[\\r\\nimport sailpoint.object.*;\\r\\nimport sailpoint.object.ProvisioningPlan.AccountRequest;\\r\\nimport sailpoint.object.ProvisioningPlan.AccountRequest.Operation;\\r\\nimport sailpoint.object.ProvisioningPlan.AttributeRequest;\\r\\nimport sailpoint.object.ProvisioningPlan;\\r\\nimport sailpoint.object.ProvisioningPlan.Operation;\\r\\n\\r\\nfor ( AccountRequest accountRequest : plan.getAccountRequests() ) {\\r\\n if ( accountRequest.getOp().equals( ProvisioningPlan.ObjectOperation.Disable ) ) {\\r\\n accountRequest.setOp( ProvisioningPlan.ObjectOperation.Modify );\\r\\n }\\r\\n if ( accountRequest.getOp().equals( ProvisioningPlan.ObjectOperation.Enable ) ) {\\r\\n accountRequest.setOp( ProvisioningPlan.ObjectOperation.Modify );\\r\\n }\\r\\n}\\r\\n\\r\\n ]]></Source>\n"
|
|
}
|
|
},
|
|
"name" : "Service Desk Integration Name",
|
|
"modified" : "2024-02-18T18:45:25.994Z",
|
|
"attributes" : {
|
|
"property" : "value",
|
|
"key" : "value"
|
|
},
|
|
"id" : "62945a496ef440189b1f03e3623411c8",
|
|
"beforeProvisioningRule" : ""
|
|
}
|
|
"@
|
|
|
|
# Create new Service Desk integration
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto
|
|
New-ServiceDeskIntegration-ServiceDeskIntegrationDto $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# New-ServiceDeskIntegration -ServiceDeskIntegrationDto $ServiceDeskIntegrationDto
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ServiceDeskIntegration"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/service-desk-integrations/{id}:
|
|
get:
|
|
tags:
|
|
- Service Desk Integration
|
|
summary: Get a Service Desk integration
|
|
description: Get an existing Service Desk integration by ID.
|
|
operationId: getServiceDeskIntegration
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: ID of the Service Desk integration to get
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getServiceDeskIntegrations
|
|
style: simple
|
|
explode: false
|
|
schema:
|
|
type: string
|
|
example: anId
|
|
responses:
|
|
'200':
|
|
description: ServiceDeskIntegrationDto with the given ID
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1service-desk-integrations/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ServiceDeskIntegrationDto.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:service-desk-integration:read
|
|
- idn:service-desk-integration:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "anId" # String | ID of the Service Desk integration to get
|
|
|
|
# Get a Service Desk integration
|
|
|
|
try {
|
|
Get-ServiceDeskIntegration-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-ServiceDeskIntegration -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegration"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
put:
|
|
tags:
|
|
- Service Desk Integration
|
|
summary: Update a Service Desk integration
|
|
description: Update an existing Service Desk integration by ID.
|
|
operationId: putServiceDeskIntegration
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: ID of the Service Desk integration to update
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getServiceDeskIntegrations
|
|
style: simple
|
|
explode: false
|
|
schema:
|
|
type: string
|
|
example: anId
|
|
requestBody:
|
|
description: The specifics of the integration to update
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1service-desk-integrations/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ServiceDeskIntegrationDto.yaml
|
|
required: true
|
|
responses:
|
|
'200':
|
|
description: ServiceDeskIntegrationDto as updated
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1service-desk-integrations/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ServiceDeskIntegrationDto.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:service-desk-integration:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "anId" # String | ID of the Service Desk integration to update
|
|
$ServiceDeskIntegrationDto = @"
|
|
{
|
|
"ownerRef" : "",
|
|
"cluster" : "xyzzy999",
|
|
"created" : "2024-01-17T18:45:25.994Z",
|
|
"description" : "A very nice Service Desk integration",
|
|
"clusterRef" : "",
|
|
"type" : "ServiceNowSDIM",
|
|
"managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ],
|
|
"provisioningConfig" : {
|
|
"managedResourceRefs" : [ {
|
|
"type" : "SOURCE",
|
|
"id" : "2c9180855d191c59015d291ceb051111",
|
|
"name" : "My Source 1"
|
|
}, {
|
|
"type" : "SOURCE",
|
|
"id" : "2c9180855d191c59015d291ceb052222",
|
|
"name" : "My Source 2"
|
|
} ],
|
|
"provisioningRequestExpiration" : 7,
|
|
"noProvisioningRequests" : true,
|
|
"universalManager" : true,
|
|
"planInitializerScript" : {
|
|
"source" : "<?xml version='1.0' encoding='UTF-8'?>\\r\\n<!DOCTYPE Rule PUBLIC \\\"sailpoint.dtd\\\" \\\"sailpoint.dtd\\\">\\r\\n<Rule name=\\\"Example Rule\\\" type=\\\"BeforeProvisioning\\\">\\r\\n <Description>Before Provisioning Rule which changes disables and enables to a modify.</Description>\\r\\n <Source><![CDATA[\\r\\nimport sailpoint.object.*;\\r\\nimport sailpoint.object.ProvisioningPlan.AccountRequest;\\r\\nimport sailpoint.object.ProvisioningPlan.AccountRequest.Operation;\\r\\nimport sailpoint.object.ProvisioningPlan.AttributeRequest;\\r\\nimport sailpoint.object.ProvisioningPlan;\\r\\nimport sailpoint.object.ProvisioningPlan.Operation;\\r\\n\\r\\nfor ( AccountRequest accountRequest : plan.getAccountRequests() ) {\\r\\n if ( accountRequest.getOp().equals( ProvisioningPlan.ObjectOperation.Disable ) ) {\\r\\n accountRequest.setOp( ProvisioningPlan.ObjectOperation.Modify );\\r\\n }\\r\\n if ( accountRequest.getOp().equals( ProvisioningPlan.ObjectOperation.Enable ) ) {\\r\\n accountRequest.setOp( ProvisioningPlan.ObjectOperation.Modify );\\r\\n }\\r\\n}\\r\\n\\r\\n ]]></Source>\n"
|
|
}
|
|
},
|
|
"name" : "Service Desk Integration Name",
|
|
"modified" : "2024-02-18T18:45:25.994Z",
|
|
"attributes" : {
|
|
"property" : "value",
|
|
"key" : "value"
|
|
},
|
|
"id" : "62945a496ef440189b1f03e3623411c8",
|
|
"beforeProvisioningRule" : ""
|
|
}
|
|
"@
|
|
|
|
# Update a Service Desk integration
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto
|
|
Send-ServiceDeskIntegration-Id $Id -ServiceDeskIntegrationDto $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Send-ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $ServiceDeskIntegrationDto
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ServiceDeskIntegration"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
delete:
|
|
tags:
|
|
- Service Desk Integration
|
|
summary: Delete a Service Desk integration
|
|
description: Delete an existing Service Desk integration by ID.
|
|
operationId: deleteServiceDeskIntegration
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: ID of Service Desk integration to delete
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getServiceDeskIntegrations
|
|
style: simple
|
|
explode: false
|
|
schema:
|
|
type: string
|
|
example: anId
|
|
responses:
|
|
'204':
|
|
description: Service Desk integration with the given ID successfully deleted
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:service-desk-integration:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "anId" # String | ID of Service Desk integration to delete
|
|
|
|
# Delete a Service Desk integration
|
|
|
|
try {
|
|
Remove-ServiceDeskIntegration-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Remove-ServiceDeskIntegration -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ServiceDeskIntegration"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
patch:
|
|
operationId: patchServiceDeskIntegration
|
|
tags:
|
|
- Service Desk Integration
|
|
summary: Patch a Service Desk Integration
|
|
description: Update an existing Service Desk integration by ID with a PATCH request.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: ID of the Service Desk integration to update
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getServiceDeskIntegrations
|
|
style: simple
|
|
explode: false
|
|
schema:
|
|
type: string
|
|
example: anId
|
|
requestBody:
|
|
required: true
|
|
description: |
|
|
A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
|
|
Only `replace` operations are accepted by this endpoint.
|
|
|
|
A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed.
|
|
content:
|
|
application/json-patch+json:
|
|
schema:
|
|
type: object
|
|
description: A JSONPatch document as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902). Only `replace` operations are accepted by this endpoint.
|
|
properties:
|
|
operations:
|
|
description: Operations to be applied
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/JsonPatchOperation.yaml
|
|
example:
|
|
- op: replace
|
|
path: /ownerRef
|
|
value:
|
|
id: 2c9180867d05b227017d09921a205b4d
|
|
type: IDENTITY
|
|
name: Angelo Medici
|
|
responses:
|
|
'200':
|
|
description: ServiceDeskIntegrationDto as updated
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1service-desk-integrations/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ServiceDeskIntegrationDto.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:service-desk-integration:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "anId" # String | ID of the Service Desk integration to update
|
|
$PatchServiceDeskIntegrationRequest = @"
|
|
|
|
"@
|
|
|
|
# Patch a Service Desk Integration
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest
|
|
Update-ServiceDeskIntegration-Id $Id -PatchServiceDeskIntegrationRequest $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Update-ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $PatchServiceDeskIntegrationRequest
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ServiceDeskIntegration"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/service-desk-integrations/types:
|
|
get:
|
|
tags:
|
|
- Service Desk Integration
|
|
summary: List Service Desk integration types
|
|
description: This API endpoint returns the current list of supported Service Desk integration types.
|
|
operationId: getServiceDeskIntegrationTypes
|
|
responses:
|
|
'200':
|
|
description: Responds with an array of the currently supported Service Desk integration types.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
description: This represents a Service Desk Integration template type.
|
|
required:
|
|
- type
|
|
- scriptName
|
|
type: object
|
|
properties:
|
|
name:
|
|
description: This is the name of the type.
|
|
example: aName
|
|
type: string
|
|
type:
|
|
description: This is the type value for the type.
|
|
example: aType
|
|
type: string
|
|
scriptName:
|
|
description: This is the scriptName attribute value for the type.
|
|
example: aScriptName
|
|
type: string
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:service-desk-integration:read
|
|
- idn:service-desk-integration:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
|
|
# List Service Desk integration types
|
|
|
|
try {
|
|
Get-ServiceDeskIntegrationTypes
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-ServiceDeskIntegrationTypes
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegrationTypes"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/service-desk-integrations/templates/{scriptName}:
|
|
get:
|
|
tags:
|
|
- Service Desk Integration
|
|
summary: Service Desk integration template by scriptName
|
|
description: This API endpoint returns an existing Service Desk integration template by scriptName.
|
|
operationId: getServiceDeskIntegrationTemplate
|
|
parameters:
|
|
- name: scriptName
|
|
in: path
|
|
description: The scriptName value of the Service Desk integration template to get
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getServiceDeskIntegrations
|
|
style: simple
|
|
explode: false
|
|
schema:
|
|
type: string
|
|
example: aScriptName
|
|
responses:
|
|
'200':
|
|
description: Responds with the ServiceDeskIntegrationTemplateDto with the specified scriptName.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/components/schemas/Account/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/BaseCommonDto.yaml
|
|
- type: object
|
|
description: This is the model for a Service Desk integration template, used to create and edit Service Desk Integrations.
|
|
required:
|
|
- type
|
|
- attributes
|
|
- provisioningConfig
|
|
properties:
|
|
type:
|
|
description: The 'type' property specifies the type of the Service Desk integration template.
|
|
type: string
|
|
example: Web Service SDIM
|
|
default: Web Service SDIM
|
|
attributes:
|
|
description: The 'attributes' property value is a map of attributes available for integrations using this Service Desk integration template.
|
|
type: object
|
|
additionalProperties: true
|
|
example:
|
|
property: value
|
|
key: value
|
|
provisioningConfig:
|
|
description: The 'provisioningConfig' property specifies the configuration used to provision integrations using the template.
|
|
$ref: '#/components/schemas/ServiceDeskIntegrationDto/allOf/0/properties/provisioningConfig'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ProvisioningConfig.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:service-desk-integration:read
|
|
- idn:service-desk-integration:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get
|
|
|
|
# Service Desk integration template by scriptName
|
|
|
|
try {
|
|
Get-ServiceDeskIntegrationTemplate-ScriptName $ScriptName
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-ServiceDeskIntegrationTemplate -ScriptName $ScriptName
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegrationTemplate"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/service-desk-integrations/status-check-configuration:
|
|
get:
|
|
tags:
|
|
- Service Desk Integration
|
|
summary: Get the time check configuration
|
|
description: Get the time check configuration of queued SDIM tickets.
|
|
operationId: getStatusCheckDetails
|
|
responses:
|
|
'200':
|
|
description: QueuedCheckConfigDetails containing the configured values
|
|
content:
|
|
application/json:
|
|
schema:
|
|
description: Configuration of maximum number of days and interval for checking Service Desk integration queue status.
|
|
required:
|
|
- provisioningStatusCheckIntervalMinutes
|
|
- provisioningMaxStatusCheckDays
|
|
type: object
|
|
properties:
|
|
provisioningStatusCheckIntervalMinutes:
|
|
description: Interval in minutes between status checks
|
|
type: string
|
|
example: 30
|
|
provisioningMaxStatusCheckDays:
|
|
description: Maximum number of days to check
|
|
type: string
|
|
example: 2
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:service-desk-integration:read
|
|
- idn:service-desk-integration:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
|
|
# Get the time check configuration
|
|
|
|
try {
|
|
Get-StatusCheckDetails
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-StatusCheckDetails
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-StatusCheckDetails"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
put:
|
|
tags:
|
|
- Service Desk Integration
|
|
summary: Update the time check configuration
|
|
description: Update the time check configuration of queued SDIM tickets.
|
|
operationId: updateStatusCheckDetails
|
|
requestBody:
|
|
description: The modified time check configuration
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1service-desk-integrations~1status-check-configuration/get/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/QueuedCheckConfigDetails.yaml
|
|
required: true
|
|
responses:
|
|
'200':
|
|
description: QueuedCheckConfigDetails as updated
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1service-desk-integrations~1status-check-configuration/get/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/QueuedCheckConfigDetails.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:service-desk-integration:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$QueuedCheckConfigDetails = @"
|
|
{
|
|
"provisioningStatusCheckIntervalMinutes" : "30",
|
|
"provisioningMaxStatusCheckDays" : "2"
|
|
}
|
|
"@
|
|
|
|
# Update the time check configuration
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails
|
|
Update-StatusCheckDetails-QueuedCheckConfigDetails $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Update-StatusCheckDetails -QueuedCheckConfigDetails $QueuedCheckConfigDetails
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-StatusCheckDetails"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/query-password-info:
|
|
post:
|
|
operationId: queryPasswordInfo
|
|
tags:
|
|
- Password Management
|
|
summary: Query Password Info
|
|
security:
|
|
- applicationAuth: []
|
|
description: |
|
|
This API is used to query password related information.
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
userName:
|
|
type: string
|
|
description: The login name of the user
|
|
example: Abby.Smith
|
|
sourceName:
|
|
type: string
|
|
description: The display name of the source
|
|
example: My-AD
|
|
responses:
|
|
'200':
|
|
description: Reference to the password info.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
identityId:
|
|
type: string
|
|
description: Identity ID
|
|
example: 2c918085744fec4301746f9a5bce4605
|
|
sourceId:
|
|
type: string
|
|
description: source ID
|
|
example: 2c918083746f642c01746f990884012a
|
|
publicKeyId:
|
|
type: string
|
|
description: public key ID
|
|
example: N2M1OTJiMGEtMDJlZS00ZWU3LTkyYTEtNjA5YmI5NWE3ZWVh
|
|
publicKey:
|
|
type: string
|
|
description: User's public key with Base64 encoding
|
|
example: MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAuGFkWi2J75TztpbaPKd36bJnIB3J8gZ6UcoS9oSDYsqBzPpTsfZXYaEf4Y4BKGgJIXmE/lwhwuj7mU1itdZ2qTSNFtnXA8Fn75c3UUkk+h+wdZbkuSmqlsJo3R1OnJkwkJggcAy9Jvk9jlcrNLWorpQ1w9raUvxtvfgkSdq153KxotenQ1HciSyZ0nA/Kw0UaucLnho8xdRowZs11afXGXA9IT9H6D8T6zUdtSxm0nAyH+mluma5LdTfaM50W3l/L8q56Vrqmx2pZIiwdx/0+g3Y++jV70zom0ZBkC1MmSoLMrQYG5OICNjr72f78B2PaGXfarQHqARLjKpMVt9YIQIDAQAB
|
|
accounts:
|
|
type: array
|
|
description: Account info related to queried identity and source
|
|
items:
|
|
type: object
|
|
properties:
|
|
accountId:
|
|
type: string
|
|
description: Account ID of the account. This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350
|
|
example: CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com
|
|
accountName:
|
|
type: string
|
|
description: Display name of the account. This is specified per account schema in the source configuration. It is used to display name of the account. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-Name-for/ta-p/74008
|
|
example: Abby.Smith
|
|
policies:
|
|
type: array
|
|
description: Password constraints
|
|
items:
|
|
type: string
|
|
example:
|
|
- passwordRepeatedChar is 3
|
|
- passwordMinAlpha is 1
|
|
- passwordMinLength is 5
|
|
- passwordMinNumeric is 1
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$PasswordInfoQueryDTO = @"
|
|
{
|
|
"sourceName" : "My-AD",
|
|
"userName" : "Abby.Smith"
|
|
}
|
|
"@
|
|
|
|
# Query Password Info
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO
|
|
Search-PasswordInfo-PasswordInfoQueryDTO $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Search-PasswordInfo -PasswordInfoQueryDTO $PasswordInfoQueryDTO
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-PasswordInfo"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/set-password:
|
|
post:
|
|
operationId: setPassword
|
|
tags:
|
|
- Password Management
|
|
summary: Set Identity's Password
|
|
security:
|
|
- applicationAuth: []
|
|
description: |
|
|
This API is used to set a password for an identity.
|
|
|
|
An identity can change their own password (as well as any of their accounts' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or ["authorization_code" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow).
|
|
|
|
>**Note: If you want to set an identity's source account password, you must enable `PASSWORD` as one of the source's features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.**
|
|
|
|
To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command:
|
|
|
|
```bash
|
|
echo -n "myPassword" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64
|
|
```
|
|
|
|
In this example, myPassword is the plain text password being set and encrypted, and public_key.pem is the path to the public key file. You can retrieve the required publicKey, along with other information like identityId, sourceId, publicKeyId, accounts, and policies, using the Query Password Info endpoint.
|
|
|
|
To successfully run this command, you must have OpenSSL installed on your machine. If OpenSSL is unavailable, consider using the Virtual Appliance (VA), which has OpenSSL pre-installed and configured.
|
|
|
|
If you are using a Windows machine, refer to this [guide](https://tecadmin.net/install-openssl-on-windows/) for instructions on installing OpenSSL.
|
|
|
|
You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password.
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
identityId:
|
|
type: string
|
|
description: The identity ID that requested the password change
|
|
example: 8a807d4c73c545510173c545f0a002ff
|
|
encryptedPassword:
|
|
type: string
|
|
description: The RSA encrypted password
|
|
example: XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==
|
|
publicKeyId:
|
|
type: string
|
|
description: The encryption key ID
|
|
example: YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2
|
|
accountId:
|
|
type: string
|
|
description: Account ID of the account This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350
|
|
example: CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com
|
|
sourceId:
|
|
type: string
|
|
description: The ID of the source for which identity is requesting the password change
|
|
example: 8a807d4c73c545510173c545d4b60246
|
|
responses:
|
|
'202':
|
|
description: Reference to the password change.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
requestId:
|
|
type: string
|
|
nullable: true
|
|
description: The password change request ID
|
|
example: 089899f13a8f4da7824996191587bab9
|
|
state:
|
|
type: string
|
|
enum:
|
|
- IN_PROGRESS
|
|
- FINISHED
|
|
- FAILED
|
|
description: Password change state
|
|
example: IN_PROGRESS
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$PasswordChangeRequest = @"
|
|
{
|
|
"sourceId" : "8a807d4c73c545510173c545d4b60246",
|
|
"accountId" : "CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com",
|
|
"identityId" : "8a807d4c73c545510173c545f0a002ff",
|
|
"publicKeyId" : "YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2",
|
|
"encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A=="
|
|
}
|
|
"@
|
|
|
|
# Set Identity's Password
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest
|
|
Set-Password-PasswordChangeRequest $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Set-Password -PasswordChangeRequest $PasswordChangeRequest
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-Password"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/password-change-status/{id}:
|
|
get:
|
|
operationId: getPasswordChangeStatus
|
|
tags:
|
|
- Password Management
|
|
summary: Get Password Change Request Status
|
|
security:
|
|
- userAuth: []
|
|
- applicationAuth: []
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
description: This API returns the status of a password change request.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: setPassword
|
|
example: 089899f13a8f4da7824996191587bab9
|
|
description: Password change request ID
|
|
responses:
|
|
'200':
|
|
description: Status of the password change request
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
requestId:
|
|
type: string
|
|
nullable: true
|
|
description: The password change request ID
|
|
example: 089899f13a8f4da7824996191587bab9
|
|
state:
|
|
type: string
|
|
enum:
|
|
- IN_PROGRESS
|
|
- FINISHED
|
|
- FAILED
|
|
description: Password change state
|
|
example: IN_PROGRESS
|
|
errors:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: The errors during the password change request
|
|
example:
|
|
- The password change payload is invalid
|
|
sourceIds:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: List of source IDs in the password change request
|
|
example:
|
|
- 2c918083746f642c01746f990884012a
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "089899f13a8f4da7824996191587bab9" # String | Password change request ID
|
|
|
|
# Get Password Change Request Status
|
|
|
|
try {
|
|
Get-PasswordChangeStatus-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-PasswordChangeStatus -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordChangeStatus"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/password-dictionary:
|
|
get:
|
|
operationId: getPasswordDictionary
|
|
tags:
|
|
- Password Dictionary
|
|
summary: Get Password Dictionary
|
|
description: |-
|
|
This gets password dictionary for the organization.
|
|
The password dictionary file can contain lines that are:
|
|
1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing
|
|
2. empty lines
|
|
3. locale line - the first line that starts with "locale=" is considered to be locale line, the rest are treated as normal content lines
|
|
4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed;
|
|
maximum length of the line is 128 Unicode codepoints
|
|
|
|
|
|
Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line).
|
|
Password dict file must contain UTF-8 characters only.
|
|
|
|
# Sample password text file
|
|
|
|
```
|
|
|
|
# Password dictionary small test file
|
|
|
|
locale=en_US
|
|
|
|
# Password dictionary prohibited words
|
|
|
|
qwerty
|
|
abcd
|
|
aaaaa
|
|
password
|
|
qazxsws
|
|
|
|
```
|
|
security:
|
|
- userAuth:
|
|
- idn:password-dictionary-management:read
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
responses:
|
|
'200':
|
|
description: A password dictionary response
|
|
content:
|
|
text/plain:
|
|
schema:
|
|
type: string
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
|
|
# Get Password Dictionary
|
|
|
|
try {
|
|
Get-PasswordDictionary
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-PasswordDictionary
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordDictionary"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
put:
|
|
operationId: putPasswordDictionary
|
|
tags:
|
|
- Password Dictionary
|
|
summary: Update Password Dictionary
|
|
description: |-
|
|
This updates password dictionary for the organization.
|
|
The password dictionary file can contain lines that are:
|
|
1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing
|
|
2. empty lines
|
|
3. locale line - the first line that starts with "locale=" is considered to be locale line, the rest are treated as normal content lines
|
|
4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed;
|
|
maximum length of the line is 128 Unicode codepoints
|
|
|
|
|
|
Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line).
|
|
Password dict file must contain UTF-8 characters only.
|
|
|
|
# Sample password text file
|
|
|
|
```
|
|
|
|
# Password dictionary small test file
|
|
|
|
locale=en_US
|
|
|
|
# Password dictionary prohibited words
|
|
|
|
qwerty
|
|
abcd
|
|
aaaaa
|
|
password
|
|
qazxsws
|
|
|
|
```
|
|
security:
|
|
- userAuth:
|
|
- idn:password-dictionary:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
requestBody:
|
|
required: true
|
|
description: The password dictionary file to be uploaded.
|
|
content:
|
|
multipart/form-data:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
file:
|
|
type: string
|
|
format: binary
|
|
responses:
|
|
'200':
|
|
description: Successfully updated.
|
|
'201':
|
|
description: Created.
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$File = # System.IO.FileInfo | (optional)
|
|
|
|
# Update Password Dictionary
|
|
|
|
try {
|
|
Send-PasswordDictionary
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Send-PasswordDictionary -File $File
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-PasswordDictionary"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/password-org-config:
|
|
get:
|
|
operationId: getPasswordOrgConfig
|
|
tags:
|
|
- Password Configuration
|
|
summary: Get Password Org Config
|
|
description: This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:read'
|
|
security:
|
|
- userAuth:
|
|
- idn:password-org-config:read
|
|
responses:
|
|
'200':
|
|
description: Reference to the password org config.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
customInstructionsEnabled:
|
|
type: boolean
|
|
description: Indicator whether custom password instructions feature is enabled. The default value is false.
|
|
default: false
|
|
example: true
|
|
digitTokenEnabled:
|
|
type: boolean
|
|
description: Indicator whether "digit token" feature is enabled. The default value is false.
|
|
default: false
|
|
example: true
|
|
digitTokenDurationMinutes:
|
|
type: integer
|
|
format: int32
|
|
description: The duration of "digit token" in minutes. The default value is 5.
|
|
minimum: 1
|
|
maximum: 60
|
|
default: 5
|
|
example: 10
|
|
digitTokenLength:
|
|
type: integer
|
|
format: int32
|
|
description: The length of "digit token". The default value is 6.
|
|
minimum: 6
|
|
maximum: 18
|
|
default: 6
|
|
example: 9
|
|
example:
|
|
customInstructionsEnabled: true
|
|
digitTokenDurationMinutes: 9
|
|
digitTokenEnabled: false
|
|
digitTokenLength: 6
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
|
|
# Get Password Org Config
|
|
|
|
try {
|
|
Get-PasswordOrgConfig
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-PasswordOrgConfig
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordOrgConfig"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
put:
|
|
operationId: putPasswordOrgConfig
|
|
tags:
|
|
- Password Configuration
|
|
summary: Update Password Org Config
|
|
description: |-
|
|
This API updates the password org config for specified fields. Other fields will keep original value.
|
|
You must set the `customInstructionsEnabled` field to "true" to be able to use custom password instructions.
|
|
Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write'
|
|
security:
|
|
- userAuth:
|
|
- idn:password-org-config:write
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1password-org-config/get/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/PasswordOrgConfig.yaml
|
|
example:
|
|
digitTokenEnabled: true
|
|
digitTokenDurationMinutes: 12
|
|
responses:
|
|
'200':
|
|
description: Reference to the password org config.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1password-org-config/get/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/PasswordOrgConfig.yaml
|
|
example:
|
|
customInstructionsEnabled: true
|
|
digitTokenDurationMinutes: 12
|
|
digitTokenEnabled: true
|
|
digitTokenLength: 6
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$PasswordOrgConfig = @"
|
|
{
|
|
"digitTokenLength" : 9,
|
|
"digitTokenEnabled" : true,
|
|
"digitTokenDurationMinutes" : 10,
|
|
"customInstructionsEnabled" : true
|
|
}
|
|
"@
|
|
|
|
# Update Password Org Config
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig
|
|
Send-PasswordOrgConfig-PasswordOrgConfig $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Send-PasswordOrgConfig -PasswordOrgConfig $PasswordOrgConfig
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-PasswordOrgConfig"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
post:
|
|
operationId: createPasswordOrgConfig
|
|
tags:
|
|
- Password Configuration
|
|
summary: Create Password Org Config
|
|
description: |-
|
|
This API creates the password org config. Unspecified fields will use default value.
|
|
To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to "true".
|
|
Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write'
|
|
security:
|
|
- userAuth:
|
|
- idn:password-org-config:write
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1password-org-config/get/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/PasswordOrgConfig.yaml
|
|
example:
|
|
customInstructionsEnabled: true
|
|
digitTokenEnabled: true
|
|
digitTokenDurationMinutes: 12
|
|
digitTokenLength: 9
|
|
responses:
|
|
'200':
|
|
description: Reference to the password org config.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1password-org-config/get/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/PasswordOrgConfig.yaml
|
|
example:
|
|
customInstructionsEnabled: true
|
|
digitTokenDurationMinutes: 9
|
|
digitTokenEnabled: true
|
|
digitTokenLength: 12
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$PasswordOrgConfig = @"
|
|
{
|
|
"digitTokenLength" : 9,
|
|
"digitTokenEnabled" : true,
|
|
"digitTokenDurationMinutes" : 10,
|
|
"customInstructionsEnabled" : true
|
|
}
|
|
"@
|
|
|
|
# Create Password Org Config
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig
|
|
New-PasswordOrgConfig-PasswordOrgConfig $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# New-PasswordOrgConfig -PasswordOrgConfig $PasswordOrgConfig
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-PasswordOrgConfig"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/reports/{taskResultId}/result:
|
|
get:
|
|
tags:
|
|
- Reports Data Extraction
|
|
description: Get the report results for a report that was run or is running. Returns empty report result in case there are no active task definitions with used in payload task definition name.
|
|
operationId: getReportResult
|
|
summary: Get Report Result
|
|
security:
|
|
- userAuth:
|
|
- sp:report-result:read
|
|
parameters:
|
|
- in: path
|
|
name: taskResultId
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: startReport
|
|
description: Unique identifier of the task result which handled report
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
- in: query
|
|
name: completed
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
required: false
|
|
description: state of task result to apply ordering when results are fetching from the DB
|
|
example: true
|
|
responses:
|
|
'200':
|
|
description: Details about report that was run or is running.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
description: Details about report result or current state.
|
|
properties:
|
|
reportType:
|
|
type: string
|
|
enum:
|
|
- ACCOUNTS
|
|
- IDENTITIES_DETAILS
|
|
- IDENTITIES
|
|
- IDENTITY_PROFILE_IDENTITY_ERROR
|
|
- ORPHAN_IDENTITIES
|
|
- SEARCH_EXPORT
|
|
- UNCORRELATED_ACCOUNTS
|
|
description: Use this property to define what report should be processed in the RDE service.
|
|
example: IDENTITIES_DETAILS
|
|
taskDefName:
|
|
type: string
|
|
description: Name of the task definition which is started to process requesting report. Usually the same as report name
|
|
example: Identities Details Report
|
|
id:
|
|
type: string
|
|
description: Unique task definition identifier.
|
|
example: a248c16fe22222b2bd49615481311111
|
|
created:
|
|
type: string
|
|
description: Report processing start date
|
|
format: date-time
|
|
example: '2020-09-07T42:14:00.364Z'
|
|
status:
|
|
type: string
|
|
enum:
|
|
- SUCCESS
|
|
- FAILURE
|
|
- WARNING
|
|
- TERMINATED
|
|
description: Report current state or result status.
|
|
example: SUCCESS
|
|
duration:
|
|
type: integer
|
|
format: int64
|
|
description: Report processing time in ms.
|
|
example: 342
|
|
rows:
|
|
type: integer
|
|
format: int64
|
|
description: Report size in rows.
|
|
example: 37
|
|
availableFormats:
|
|
type: array
|
|
items:
|
|
type: string
|
|
enum:
|
|
- CSV
|
|
- PDF
|
|
description: Output report file formats. This are formats for calling get endpoint as a query parameter 'fileFormat'. In case report won't have this argument there will be ['CSV', 'PDF'] as default.
|
|
example:
|
|
- CSV
|
|
examples:
|
|
identityDetailsReport:
|
|
summary: Identities Details Report result.
|
|
value:
|
|
reportType: IDENTITIES_DETAILS
|
|
taskDefName: Identities Details Report
|
|
id: 1e01d272b8084c4fa12fcf8fa898102d
|
|
created: '2023-09-07T42:14:05.122Z'
|
|
status: SUCCESS
|
|
duration: 3681
|
|
rows: 193
|
|
availableFormats:
|
|
- CSV
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$TaskResultId = "ef38f94347e94562b5bb8424a56397d8" # String | Unique identifier of the task result which handled report
|
|
$Completed = $true # Boolean | state of task result to apply ordering when results are fetching from the DB (optional) (default to $false)
|
|
|
|
# Get Report Result
|
|
|
|
try {
|
|
Get-ReportResult-TaskResultId $TaskResultId
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-ReportResult -TaskResultId $TaskResultId -Completed $Completed
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ReportResult"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/reports/run:
|
|
post:
|
|
tags:
|
|
- Reports Data Extraction
|
|
description: Use this API to run a report according to report input details. If non-concurrent task is already running then it returns, otherwise new task creates and returns.
|
|
operationId: startReport
|
|
summary: Run Report
|
|
security:
|
|
- userAuth:
|
|
- sp:report:manage
|
|
- applicationAuth:
|
|
- sp:report:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- CERT_ADMIN
|
|
- REPORT_ADMIN
|
|
- ROLE_ADMIN
|
|
- ROLE_SUBADMIN
|
|
- SOURCE_ADMIN
|
|
- SOURCE_SUBADMIN
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
description: Details about report to be processed.
|
|
properties:
|
|
reportType:
|
|
type: string
|
|
enum:
|
|
- ACCOUNTS
|
|
- IDENTITIES_DETAILS
|
|
- IDENTITIES
|
|
- IDENTITY_PROFILE_IDENTITY_ERROR
|
|
- ORPHAN_IDENTITIES
|
|
- SEARCH_EXPORT
|
|
- UNCORRELATED_ACCOUNTS
|
|
description: Use this property to define what report should be processed in the RDE service.
|
|
example: ACCOUNTS
|
|
arguments:
|
|
oneOf:
|
|
- title: ACCOUNTS
|
|
type: object
|
|
description: Arguments for Account Export report (ACCOUNTS)
|
|
required:
|
|
- application
|
|
- sourceName
|
|
properties:
|
|
application:
|
|
type: string
|
|
description: Source ID.
|
|
example: 2c9180897eSourceIde781782f705b9
|
|
sourceName:
|
|
type: string
|
|
description: Source name.
|
|
example: Active Directory
|
|
- title: IDENTITIES_DETAILS
|
|
type: object
|
|
description: Arguments for Identities Details report (IDENTITIES_DETAILS)
|
|
required:
|
|
- correlatedOnly
|
|
properties:
|
|
correlatedOnly:
|
|
type: boolean
|
|
description: Flag to specify if only correlated identities are included in report.
|
|
default: false
|
|
example: true
|
|
- title: IDENTITIES
|
|
type: object
|
|
description: Arguments for Identities report (IDENTITIES)
|
|
properties:
|
|
correlatedOnly:
|
|
type: boolean
|
|
description: Flag to specify if only correlated identities are included in report.
|
|
default: false
|
|
example: true
|
|
- title: IDENTITY_PROFILE_IDENTITY_ERROR
|
|
type: object
|
|
description: Arguments for Identity Profile Identity Error report (IDENTITY_PROFILE_IDENTITY_ERROR)
|
|
required:
|
|
- authoritativeSource
|
|
properties:
|
|
authoritativeSource:
|
|
type: string
|
|
description: Source ID.
|
|
example: 1234sourceId5678902
|
|
- title: ORPHAN_IDENTITIES
|
|
type: object
|
|
description: Arguments for Orphan Identities report (ORPHAN_IDENTITIES)
|
|
properties:
|
|
selectedFormats:
|
|
type: array
|
|
items:
|
|
type: string
|
|
enum:
|
|
- CSV
|
|
- PDF
|
|
description: Output report file formats. These are formats for calling GET endpoint as query parameter 'fileFormat'. In case report won't have this argument there will be ['CSV', 'PDF'] as default.
|
|
example:
|
|
- CSV
|
|
- title: SEARCH_EXPORT
|
|
type: object
|
|
description: |
|
|
Arguments for Search Export report (SEARCH_EXPORT)
|
|
|
|
The report file generated will be a zip file containing csv files of the search results.
|
|
required:
|
|
- query
|
|
properties:
|
|
indices:
|
|
description: The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched.
|
|
externalDocs:
|
|
description: Learn more about search indices here.
|
|
url: https://documentation.sailpoint.com/saas/help/search/searchable-fields.html
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/SavedSearch/allOf/2/properties/indices/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/Index.yaml
|
|
example:
|
|
- entitlements
|
|
query:
|
|
description: The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries.
|
|
type: string
|
|
example: name:a*
|
|
columns:
|
|
description: |
|
|
Comma separated string consisting of technical attribute names of fields to include in report.
|
|
|
|
Use `access.spread`, `apps.spread`, `accounts.spread` to include respective identity access details.
|
|
|
|
Use `accessProfiles.spread` to unclude access profile details.
|
|
|
|
Use `entitlements.spread` to include entitlement details.
|
|
type: string
|
|
example: displayName,firstName,lastName,email,created,attributes.cloudLifecycleState
|
|
sort:
|
|
description: The fields to be used to sort the search results. Use + or - to specify the sort direction.
|
|
type: array
|
|
items:
|
|
type: string
|
|
example:
|
|
- displayName
|
|
- +id
|
|
- title: UNCORRELATED_ACCOUNTS
|
|
type: object
|
|
description: Arguments for Uncorrelated Accounts report (UNCORRELATED_ACCOUNTS)
|
|
properties:
|
|
selectedFormats:
|
|
type: array
|
|
items:
|
|
type: string
|
|
enum:
|
|
- CSV
|
|
- PDF
|
|
description: Output report file formats. These are formats for calling GET endpoint as query parameter 'fileFormat'. In case report won't have this argument there will be ['CSV', 'PDF'] as default.
|
|
example:
|
|
- CSV
|
|
example:
|
|
application: 2c9180897e7742b2017e781782f705b9
|
|
sourceName: Active Directory
|
|
description: The string-object map(dictionary) with the arguments needed for report processing.
|
|
examples:
|
|
Account Export Report:
|
|
summary: Account Export report
|
|
value:
|
|
reportType: ACCOUNTS
|
|
arguments:
|
|
application: 2c9180897eSourceIde781782f705b9
|
|
sourceName: Active Directory
|
|
Identities Details Report:
|
|
summary: Identities Details report
|
|
value:
|
|
reportType: IDENTITIES_DETAILS
|
|
arguments:
|
|
correlatedOnly: true
|
|
Identities Report:
|
|
summary: Identities report
|
|
value:
|
|
reportType: IDENTITIES
|
|
arguments:
|
|
correlatedOnly: true
|
|
Identity Profile Identity Error Report:
|
|
summary: Identity Profile Identity Error report
|
|
value:
|
|
reportType: IDENTITY_PROFILE_IDENTITY_ERROR
|
|
arguments:
|
|
authoritativeSource: 2c9180847de347aa017de8ef09167792
|
|
Orphan Identities Report:
|
|
summary: Orphan Identities report
|
|
value:
|
|
reportType: ORPHAN_IDENTITIES
|
|
arguments:
|
|
selectedFormats:
|
|
- CSV
|
|
- PDF
|
|
Search Export Report:
|
|
summary: Search Export report
|
|
value:
|
|
reportType: SEARCH_EXPORT
|
|
arguments:
|
|
indices:
|
|
- identities
|
|
query: attributes.city:London
|
|
columns: displayName,firstName,lastName,email,attributes.city,created,attributes.cloudLifecycleState,access.spread
|
|
sort:
|
|
- +displayName
|
|
Uncorrelated Accounts Report:
|
|
summary: Uncorrelated Accounts report
|
|
value:
|
|
reportType: UNCORRELATED_ACCOUNTS
|
|
arguments:
|
|
selectedFormats:
|
|
- CSV
|
|
- PDF
|
|
required: true
|
|
responses:
|
|
'200':
|
|
description: Details about running report task.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
description: Details about job or task type, state and lifecycle.
|
|
properties:
|
|
type:
|
|
type: string
|
|
enum:
|
|
- QUARTZ
|
|
- QPOC
|
|
- MENTOS
|
|
- QUEUED_TASK
|
|
description: Type of the job or task underlying in the report processing. It could be a quartz task, QPOC or MENTOS jobs or a refresh/sync task.
|
|
example: MENTOS
|
|
id:
|
|
type: string
|
|
description: Unique task definition identifier.
|
|
example: a248c16fe22222b2bd49615481311111
|
|
reportType:
|
|
enum:
|
|
- ACCOUNTS
|
|
- IDENTITIES_DETAILS
|
|
- IDENTITIES
|
|
- IDENTITY_PROFILE_IDENTITY_ERROR
|
|
- ORPHAN_IDENTITIES
|
|
- SEARCH_EXPORT
|
|
- UNCORRELATED_ACCOUNTS
|
|
description: Use this property to define what report should be processed in the RDE service.
|
|
example: IDENTITIES_DETAILS
|
|
description:
|
|
type: string
|
|
description: Description of the report purpose and/or contents.
|
|
example: A detailed view of the identities in the system.
|
|
parentName:
|
|
type: string
|
|
nullable: true
|
|
description: Name of the parent task/report if exists.
|
|
example: Audit Report
|
|
launcher:
|
|
type: string
|
|
description: Name of the report processing initiator.
|
|
example: cloudadmin
|
|
created:
|
|
type: string
|
|
description: Report creation date
|
|
format: date-time
|
|
example: '2020-09-07T42:14:00.364Z'
|
|
launched:
|
|
type: string
|
|
nullable: true
|
|
format: date-time
|
|
description: Report start date
|
|
example: '2020-09-07T42:14:00.521Z'
|
|
completed:
|
|
type: string
|
|
nullable: true
|
|
format: date-time
|
|
description: Report completion date
|
|
example: '2020-09-07T42:14:01.137Z'
|
|
completionStatus:
|
|
type: string
|
|
nullable: true
|
|
enum:
|
|
- SUCCESS
|
|
- WARNING
|
|
- ERROR
|
|
- TERMINATED
|
|
- TEMP_ERROR
|
|
description: Report completion status.
|
|
example: Success
|
|
messages:
|
|
type: array
|
|
description: List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors.
|
|
example: []
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: Type of the message.
|
|
enum:
|
|
- INFO
|
|
- WARN
|
|
- ERROR
|
|
example: WARN
|
|
error:
|
|
type: boolean
|
|
default: false
|
|
description: Flag whether message is an error.
|
|
example: false
|
|
warning:
|
|
type: boolean
|
|
default: false
|
|
description: Flag whether message is a warning.
|
|
example: true
|
|
key:
|
|
type: string
|
|
description: Message string identifier.
|
|
example: 'The following account(s) failed to correlate: A,B,C'
|
|
localizedText:
|
|
type: string
|
|
description: Message context with the locale based language.
|
|
example: 'The following account(s) failed to correlate: A,B,C'
|
|
returns:
|
|
type: array
|
|
description: Task definition results, if necessary.
|
|
example: []
|
|
items:
|
|
type: object
|
|
properties:
|
|
displayLabel:
|
|
type: string
|
|
description: Attribute description.
|
|
example: ' '
|
|
attributeName:
|
|
type: string
|
|
description: System or database attribute name.
|
|
example: ' '
|
|
attributes:
|
|
type: object
|
|
description: Extra attributes map(dictionary) needed for the report.
|
|
additionalProperties:
|
|
type: object
|
|
example:
|
|
org: an-org
|
|
progress:
|
|
type: string
|
|
nullable: true
|
|
description: Current report state.
|
|
example: Initializing...
|
|
examples:
|
|
identityDetailsReport:
|
|
summary: Identities Details Report task result.
|
|
value:
|
|
reportType: IDENTITIES_DETAILS
|
|
taskDefName: Identities Details Report
|
|
type: QUARTZ
|
|
id: a248c16fe22222b2bd49615481311111
|
|
created: '2023-09-07T42:14:00.364Z'
|
|
description: A detailed view of the identities in the system.
|
|
parentName: Audit Report
|
|
launcher: '9832285'
|
|
launched: '2023-09-07T42:14:00.521Z'
|
|
completed: '2023-09-07T42:14:01.137Z'
|
|
messages: []
|
|
returns: []
|
|
attributes:
|
|
org: an-org
|
|
progress: Initializing...
|
|
searchExportReport:
|
|
summary: Identities Details Report task result.
|
|
value:
|
|
reportType: SEARCH_EXPORT
|
|
taskDefName: Search Export
|
|
type: QUARTZ
|
|
id: a248c16fe22222b2bd49615481311111
|
|
created: '2023-09-07T42:14:11.137Z'
|
|
description: Extract query data from ElasticSearch to CSV
|
|
parentName: null
|
|
launcher: T05293
|
|
launched: '2020-09-07T42:14:11.137Z'
|
|
completed: '2020-09-07T42:14:13.451Z'
|
|
messages: []
|
|
returns: []
|
|
attributes:
|
|
queryHash: 5e12cf79c67d92e23d4d8cb3e974f87d164e86d4a48d32ecf89645cacfd3f2
|
|
org: an-org
|
|
queryParams:
|
|
columns: displayName,firstName,lastName,email,created,attributes.cloudLifecycleState,tags,access.spread,apps.pread,accounts.spread
|
|
indices: identities
|
|
ownerId: 95ecba5c5444439c999aec638ce2a777
|
|
query: 700007
|
|
sort: displayName
|
|
progress: Initializing...
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$ReportDetails = @"
|
|
{
|
|
"reportType" : "ACCOUNTS",
|
|
"arguments" : {
|
|
"application" : "2c9180897e7742b2017e781782f705b9",
|
|
"sourceName" : "Active Directory"
|
|
}
|
|
}
|
|
"@
|
|
|
|
# Run Report
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToReportDetails -Json $ReportDetails
|
|
Start-Report-ReportDetails $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Start-Report -ReportDetails $ReportDetails
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-Report"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/reports/{id}/cancel:
|
|
post:
|
|
tags:
|
|
- Reports Data Extraction
|
|
description: Cancels a running report.
|
|
operationId: cancelReport
|
|
summary: Cancel Report
|
|
security:
|
|
- userAuth:
|
|
- sp:report:delete
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: ID of the running Report to cancel
|
|
required: true
|
|
x-sailpoint-resource-operation-id: startReport
|
|
style: simple
|
|
explode: false
|
|
schema:
|
|
type: string
|
|
example: a1ed223247144cc29d23c632624b4767
|
|
responses:
|
|
'204':
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/204.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "a1ed223247144cc29d23c632624b4767" # String | ID of the running Report to cancel
|
|
|
|
# Cancel Report
|
|
|
|
try {
|
|
Suspend-Report-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Suspend-Report -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-Report"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/reports/{taskResultId}:
|
|
get:
|
|
tags:
|
|
- Reports Data Extraction
|
|
description: Gets a report in file format.
|
|
operationId: getReport
|
|
summary: Get Report File
|
|
security:
|
|
- userAuth:
|
|
- sp:report:read
|
|
parameters:
|
|
- in: path
|
|
name: taskResultId
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: startReport
|
|
description: Unique identifier of the task result which handled report
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
- in: query
|
|
name: fileFormat
|
|
schema:
|
|
type: string
|
|
enum:
|
|
- csv
|
|
- pdf
|
|
required: true
|
|
description: Output format of the requested report file
|
|
example: csv
|
|
- in: query
|
|
name: name
|
|
required: false
|
|
schema:
|
|
type: string
|
|
example: Identities Details Report
|
|
description: preferred Report file name, by default will be used report name from task result.
|
|
- in: query
|
|
name: auditable
|
|
required: false
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
example: true
|
|
description: Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId.
|
|
responses:
|
|
'200':
|
|
description: Report file in selected format. CSV by default.
|
|
content:
|
|
application/csv:
|
|
schema:
|
|
type: string
|
|
format: binary
|
|
application/pdf:
|
|
schema:
|
|
type: string
|
|
format: binary
|
|
headers:
|
|
Content-disposition:
|
|
description: The requested report's filename
|
|
schema:
|
|
type: string
|
|
example: attachment;filename=\"fileName"
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
description: Not Found - returned if the request URL refers to a resource or object that does not exist
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/400/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ErrorResponseDto.yaml
|
|
examples:
|
|
'404':
|
|
summary: An example of a 404 response object
|
|
value:
|
|
detailCode: 404 Not found
|
|
trackingId: b21b1f7ce4da4d639f2c62a57171b427
|
|
messages:
|
|
- locale: en-US
|
|
localeOrigin: DEFAULT
|
|
text: <h1>File Not Found - 404 Error</h1> The requested file was not found.
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$TaskResultId = "ef38f94347e94562b5bb8424a56397d8" # String | Unique identifier of the task result which handled report
|
|
$FileFormat = "csv" # String | Output format of the requested report file
|
|
$Name = "Identities Details Report" # String | preferred Report file name, by default will be used report name from task result. (optional)
|
|
$Auditable = $true # Boolean | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to $false)
|
|
|
|
# Get Report File
|
|
|
|
try {
|
|
Get-Report-TaskResultId $TaskResultId -FileFormat $FileFormat
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-Report -TaskResultId $TaskResultId -FileFormat $FileFormat -Name $Name -Auditable $Auditable
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Report"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/sod-policies:
|
|
post:
|
|
security:
|
|
- userAuth:
|
|
- idn:sod-policy:write
|
|
operationId: createSodPolicy
|
|
tags:
|
|
- SOD Policies
|
|
summary: Create SOD policy
|
|
description: |-
|
|
This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy.
|
|
Requires role of ORG_ADMIN.
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: Policy id
|
|
example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde
|
|
readOnly: true
|
|
name:
|
|
type: string
|
|
description: Policy Business Name
|
|
example: policy-xyz
|
|
created:
|
|
type: string
|
|
format: date-time
|
|
description: The time when this SOD policy is created.
|
|
example: '2020-01-01T00:00:00.000000Z'
|
|
readOnly: true
|
|
modified:
|
|
type: string
|
|
format: date-time
|
|
description: The time when this SOD policy is modified.
|
|
example: '2020-01-01T00:00:00.000000Z'
|
|
readOnly: true
|
|
description:
|
|
type: string
|
|
description: Optional description of the SOD policy
|
|
example: This policy ensures compliance of xyz
|
|
nullable: true
|
|
ownerRef:
|
|
type: object
|
|
description: The owner of the SOD policy.
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: Owner type.
|
|
enum:
|
|
- IDENTITY
|
|
- GOVERNANCE_GROUP
|
|
example: IDENTITY
|
|
id:
|
|
type: string
|
|
description: Owner's ID.
|
|
example: 2c9180a46faadee4016fb4e018c20639
|
|
name:
|
|
type: string
|
|
description: Owner's name.
|
|
example: Support
|
|
externalPolicyReference:
|
|
type: string
|
|
description: Optional External Policy Reference
|
|
example: XYZ policy
|
|
nullable: true
|
|
policyQuery:
|
|
type: string
|
|
description: Search query of the SOD policy
|
|
example: '@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)'
|
|
compensatingControls:
|
|
type: string
|
|
description: Optional compensating controls(Mitigating Controls)
|
|
example: Have a manager review the transaction decisions for their "out of compliance" employee
|
|
nullable: true
|
|
correctionAdvice:
|
|
type: string
|
|
description: Optional correction advice
|
|
example: Based on the role of the employee, managers should remove access that is not required for their job function.
|
|
nullable: true
|
|
state:
|
|
type: string
|
|
description: whether the policy is enforced or not
|
|
enum:
|
|
- ENFORCED
|
|
- NOT_ENFORCED
|
|
example: ENFORCED
|
|
tags:
|
|
type: array
|
|
description: tags for this policy object
|
|
example:
|
|
- TAG1
|
|
- TAG2
|
|
items:
|
|
type: string
|
|
creatorId:
|
|
type: string
|
|
description: Policy's creator ID
|
|
example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde
|
|
readOnly: true
|
|
modifierId:
|
|
type: string
|
|
description: Policy's modifier ID
|
|
example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde
|
|
nullable: true
|
|
readOnly: true
|
|
violationOwnerAssignmentConfig:
|
|
type: object
|
|
properties:
|
|
assignmentRule:
|
|
type: string
|
|
enum:
|
|
- MANAGER
|
|
- STATIC
|
|
- null
|
|
description: |-
|
|
Details about the violations owner.
|
|
MANAGER - identity's manager
|
|
STATIC - Governance Group or Identity
|
|
example: MANAGER
|
|
nullable: true
|
|
ownerRef:
|
|
type: object
|
|
description: The owner of the violation assignment config.
|
|
nullable: true
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: Owner type.
|
|
enum:
|
|
- IDENTITY
|
|
- GOVERNANCE_GROUP
|
|
- MANAGER
|
|
- null
|
|
example: IDENTITY
|
|
id:
|
|
type: string
|
|
description: Owner's ID.
|
|
example: 2c9180a46faadee4016fb4e018c20639
|
|
name:
|
|
type: string
|
|
description: Owner's name.
|
|
example: Support
|
|
scheduled:
|
|
type: boolean
|
|
description: defines whether a policy has been scheduled or not
|
|
example: true
|
|
default: false
|
|
type:
|
|
type: string
|
|
description: whether a policy is query based or conflicting access based
|
|
default: GENERAL
|
|
enum:
|
|
- GENERAL
|
|
- CONFLICTING_ACCESS_BASED
|
|
example: GENERAL
|
|
conflictingAccessCriteria:
|
|
allOf:
|
|
- type: object
|
|
properties:
|
|
leftCriteria:
|
|
type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Business name for the access construct list
|
|
example: money-in
|
|
criteriaList:
|
|
type: array
|
|
description: List of criteria. There is a min of 1 and max of 50 items in the list.
|
|
minItems: 1
|
|
maxItems: 50
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
enum:
|
|
- ENTITLEMENT
|
|
description: Type of the propery to which this reference applies to
|
|
example: ENTITLEMENT
|
|
id:
|
|
type: string
|
|
description: ID of the object to which this reference applies to
|
|
example: 2c91808568c529c60168cca6f90c1313
|
|
name:
|
|
type: string
|
|
description: Human-readable display name of the object to which this reference applies to
|
|
example: Administrator
|
|
example:
|
|
- type: ENTITLEMENT
|
|
id: 2c9180866166b5b0016167c32ef31a66
|
|
name: Administrator
|
|
- type: ENTITLEMENT
|
|
id: 2c9180866166b5b0016167c32ef31a67
|
|
name: Administrator
|
|
rightCriteria:
|
|
$ref: '#/paths/~1sod-policies/post/requestBody/content/application~1json/schema/properties/conflictingAccessCriteria/allOf/0/properties/leftCriteria'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/AccessCriteria.yaml
|
|
- nullable: true
|
|
examples:
|
|
Conflicting Access Based Policy:
|
|
value:
|
|
name: Conflicting-Policy-Name
|
|
description: This policy ensures compliance of xyz
|
|
ownerRef:
|
|
type: IDENTITY
|
|
id: 2c91808568c529c60168cca6f90c1313
|
|
name: Owner Name
|
|
externalPolicyReference: XYZ policy
|
|
compensatingControls: Have a manager review the transaction decisions for their "out of compliance" employee
|
|
correctionAdvice: Based on the role of the employee, managers should remove access that is not required for their job function.
|
|
state: ENFORCED
|
|
tags:
|
|
- string
|
|
creatorId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde
|
|
modifierId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde
|
|
violationOwnerAssignmentConfig:
|
|
assignmentRule: MANAGER
|
|
ownerRef:
|
|
type: IDENTITY
|
|
id: 2c91808568c529c60168cca6f90c1313
|
|
name: Violation Owner Name
|
|
scheduled: true
|
|
type: CONFLICTING_ACCESS_BASED
|
|
conflictingAccessCriteria:
|
|
leftCriteria:
|
|
name: money-in
|
|
criteriaList:
|
|
- type: ENTITLEMENT
|
|
id: 2c9180866166b5b0016167c32ef31a66
|
|
- type: ENTITLEMENT
|
|
id: 2c9180866166b5b0016167c32ef31a67
|
|
rightCriteria:
|
|
name: money-out
|
|
criteriaList:
|
|
- type: ENTITLEMENT
|
|
id: 2c9180866166b5b0016167c32ef31a68
|
|
- type: ENTITLEMENT
|
|
id: 2c9180866166b5b0016167c32ef31a69
|
|
General Policy:
|
|
value:
|
|
description: Description
|
|
ownerRef:
|
|
type: IDENTITY
|
|
id: 2c918087682f9a86016839c05e8f1aff
|
|
name: Owner Name
|
|
externalPolicyReference: New policy
|
|
policyQuery: policy query implementation
|
|
compensatingControls: Compensating controls
|
|
correctionAdvice: Correction advice
|
|
tags: []
|
|
state: ENFORCED
|
|
scheduled: false
|
|
creatorId: 2c918087682f9a86016839c05e8f1aff
|
|
modifierId: null
|
|
violationOwnerAssignmentConfig: null
|
|
name: General-Policy-Name
|
|
responses:
|
|
'201':
|
|
description: SOD policy created
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1sod-policies/post/requestBody/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/SodPolicy.yaml
|
|
examples:
|
|
Conflicting Access Based Policy:
|
|
value:
|
|
id: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde
|
|
name: Conflicting-Policy-Name
|
|
created: '2020-01-01T00:00:00.000000Z'
|
|
modified: '2020-01-01T00:00:00.000000Z'
|
|
description: This policy ensures compliance of xyz
|
|
ownerRef:
|
|
type: IDENTITY
|
|
id: 2c91808568c529c60168cca6f90c1313
|
|
name: Owner Name
|
|
externalPolicyReference: XYZ policy
|
|
policyQuery: '@access(id:2c9180866166b5b0016167c32ef31a66 OR id:2c9180866166b5b0016167c32ef31a67) AND @access(id:2c9180866166b5b0016167c32ef31a68 OR id:2c9180866166b5b0016167c32ef31a69)'
|
|
compensatingControls: Have a manager review the transaction decisions for their "out of compliance" employee
|
|
correctionAdvice: Based on the role of the employee, managers should remove access that is not required for their job function.
|
|
state: ENFORCED
|
|
tags:
|
|
- string
|
|
creatorId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde
|
|
modifierId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde
|
|
violationOwnerAssignmentConfig:
|
|
assignmentRule: MANAGER
|
|
ownerRef:
|
|
type: IDENTITY
|
|
id: 2c91808568c529c60168cca6f90c1313
|
|
name: Violation Owner Name
|
|
scheduled: true
|
|
type: CONFLICTING_ACCESS_BASED
|
|
conflictingAccessCriteria:
|
|
leftCriteria:
|
|
name: money-in
|
|
criteriaList:
|
|
- type: ENTITLEMENT
|
|
id: 2c9180866166b5b0016167c32ef31a66
|
|
- type: ENTITLEMENT
|
|
id: 2c9180866166b5b0016167c32ef31a67
|
|
rightCriteria:
|
|
name: money-out
|
|
criteriaList:
|
|
- type: ENTITLEMENT
|
|
id: 2c9180866166b5b0016167c32ef31a68
|
|
- type: ENTITLEMENT
|
|
id: 2c9180866166b5b0016167c32ef31a69
|
|
General Policy:
|
|
value:
|
|
description: Description
|
|
ownerRef:
|
|
type: IDENTITY
|
|
id: 2c918087682f9a86016839c05e8f1aff
|
|
name: Owner Name
|
|
externalPolicyReference: New policy
|
|
policyQuery: policy query implementation
|
|
compensatingControls: Compensating controls
|
|
correctionAdvice: Correction advice
|
|
tags: []
|
|
state: ENFORCED
|
|
scheduled: false
|
|
creatorId: 2c918087682f9a86016839c05e8f1aff
|
|
modifierId: null
|
|
violationOwnerAssignmentConfig: null
|
|
type: GENERAL
|
|
conflictingAccessCriteria: null
|
|
id: 52c11db4-733e-4c31-949a-766c95ec95f1
|
|
name: General-Policy-Name
|
|
created: '2020-05-12T19:47:38Z'
|
|
modified: '2020-05-12T19:47:38Z'
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$SodPolicy = @"
|
|
{
|
|
"conflictingAccessCriteria" : {
|
|
"leftCriteria" : {
|
|
"name" : "money-in",
|
|
"criteriaList" : [ {
|
|
"type" : "ENTITLEMENT",
|
|
"id" : "2c9180866166b5b0016167c32ef31a66",
|
|
"name" : "Administrator"
|
|
}, {
|
|
"type" : "ENTITLEMENT",
|
|
"id" : "2c9180866166b5b0016167c32ef31a67",
|
|
"name" : "Administrator"
|
|
} ]
|
|
},
|
|
"rightCriteria" : {
|
|
"name" : "money-in",
|
|
"criteriaList" : [ {
|
|
"type" : "ENTITLEMENT",
|
|
"id" : "2c9180866166b5b0016167c32ef31a66",
|
|
"name" : "Administrator"
|
|
}, {
|
|
"type" : "ENTITLEMENT",
|
|
"id" : "2c9180866166b5b0016167c32ef31a67",
|
|
"name" : "Administrator"
|
|
} ]
|
|
}
|
|
},
|
|
"ownerRef" : {
|
|
"name" : "Support",
|
|
"id" : "2c9180a46faadee4016fb4e018c20639",
|
|
"type" : "IDENTITY"
|
|
},
|
|
"created" : "2020-01-01T00:00:00Z",
|
|
"scheduled" : true,
|
|
"creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde",
|
|
"modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde",
|
|
"description" : "This policy ensures compliance of xyz",
|
|
"violationOwnerAssignmentConfig" : {
|
|
"assignmentRule" : "MANAGER",
|
|
"ownerRef" : {
|
|
"name" : "Support",
|
|
"id" : "2c9180a46faadee4016fb4e018c20639",
|
|
"type" : "IDENTITY"
|
|
}
|
|
},
|
|
"correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.",
|
|
"type" : "GENERAL",
|
|
"tags" : [ "TAG1", "TAG2" ],
|
|
"name" : "policy-xyz",
|
|
"modified" : "2020-01-01T00:00:00Z",
|
|
"policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)",
|
|
"compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee",
|
|
"id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde",
|
|
"state" : "ENFORCED",
|
|
"externalPolicyReference" : "XYZ policy"
|
|
}
|
|
"@
|
|
|
|
# Create SOD policy
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy
|
|
New-SodPolicy-SodPolicy $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# New-SodPolicy -SodPolicy $SodPolicy
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SodPolicy"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
get:
|
|
security:
|
|
- userAuth:
|
|
- idn:sod-policy:read
|
|
operationId: listSodPolicies
|
|
tags:
|
|
- SOD Policies
|
|
summary: List SOD policies
|
|
description: |-
|
|
This gets list of all SOD policies.
|
|
Requires role of ORG_ADMIN
|
|
parameters:
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
- in: query
|
|
name: filters
|
|
schema:
|
|
type: string
|
|
description: |-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
**id**: *eq, in*
|
|
|
|
**name**: *eq, in*
|
|
|
|
**state**: *eq, in*
|
|
example: id eq "bc693f07e7b645539626c25954c58554"
|
|
required: false
|
|
- in: query
|
|
name: sorters
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: comma-separated
|
|
example: id,name
|
|
description: |-
|
|
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
|
|
|
Sorting is supported for the following fields: **id, name, created, modified, description**
|
|
responses:
|
|
'200':
|
|
description: List of all SOD policies.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1sod-policies/post/requestBody/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/SodPolicy.yaml
|
|
example:
|
|
- id: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde
|
|
name: Conflicting-Policy-Name
|
|
created: '2020-01-01T00:00:00.000000Z'
|
|
modified: '2020-01-01T00:00:00.000000Z'
|
|
description: This policy ensures compliance of xyz
|
|
ownerRef:
|
|
type: IDENTITY
|
|
id: 2c91808568c529c60168cca6f90c1313
|
|
name: Owner Name
|
|
externalPolicyReference: XYZ policy
|
|
policyQuery: '@access(id:2c9180866166b5b0016167c32ef31a66 OR id:2c9180866166b5b0016167c32ef31a67) AND @access(id:2c9180866166b5b0016167c32ef31a68 OR id:2c9180866166b5b0016167c32ef31a69)'
|
|
compensatingControls: Have a manager review the transaction decisions for their "out of compliance" employee
|
|
correctionAdvice: Based on the role of the employee, managers should remove access that is not required for their job function.
|
|
state: ENFORCED
|
|
tags:
|
|
- string
|
|
creatorId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde
|
|
modifierId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde
|
|
violationOwnerAssignmentConfig:
|
|
assignmentRule: MANAGER
|
|
ownerRef:
|
|
type: IDENTITY
|
|
id: 2c91808568c529c60168cca6f90c1313
|
|
name: Violation Owner Name
|
|
scheduled: true
|
|
type: CONFLICTING_ACCESS_BASED
|
|
conflictingAccessCriteria:
|
|
leftCriteria:
|
|
name: money-in
|
|
criteriaList:
|
|
- type: ENTITLEMENT
|
|
id: 2c9180866166b5b0016167c32ef31a66
|
|
- type: ENTITLEMENT
|
|
id: 2c9180866166b5b0016167c32ef31a67
|
|
rightCriteria:
|
|
name: money-out
|
|
criteriaList:
|
|
- type: ENTITLEMENT
|
|
id: 2c9180866166b5b0016167c32ef31a68
|
|
- type: ENTITLEMENT
|
|
id: 2c9180866166b5b0016167c32ef31a69
|
|
- description: Description
|
|
ownerRef:
|
|
type: IDENTITY
|
|
id: 2c918087682f9a86016839c05e8f1aff
|
|
name: Owner Name
|
|
externalPolicyReference: New policy
|
|
policyQuery: policy query implementation
|
|
compensatingControls: Compensating controls
|
|
correctionAdvice: Correction advice
|
|
tags: []
|
|
state: ENFORCED
|
|
scheduled: false
|
|
creatorId: 2c918087682f9a86016839c05e8f1aff
|
|
modifierId: null
|
|
violationOwnerAssignmentConfig: null
|
|
type: GENERAL
|
|
conflictingAccessCriteria: null
|
|
id: 52c11db4-733e-4c31-949a-766c95ec95f1
|
|
name: General-Policy-Name
|
|
created: '2020-05-12T19:47:38Z'
|
|
modified: '2020-05-12T19:47:38Z'
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
$Filters = "id eq "bc693f07e7b645539626c25954c58554"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional)
|
|
$Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional)
|
|
|
|
# List SOD policies
|
|
|
|
try {
|
|
Get-SodPolicies
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicies"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/sod-policies/{id}:
|
|
get:
|
|
security:
|
|
- userAuth:
|
|
- idn:sod-policy:read
|
|
operationId: getSodPolicy
|
|
tags:
|
|
- SOD Policies
|
|
summary: Get SOD policy by ID
|
|
description: |-
|
|
This gets specified SOD policy.
|
|
Requires role of ORG_ADMIN.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listSodPolicies
|
|
description: The ID of the SOD Policy to retrieve.
|
|
example: ef38f943-47e9-4562-b5bb-8424a56397d8
|
|
responses:
|
|
'200':
|
|
description: SOD policy ID.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1sod-policies/post/requestBody/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/SodPolicy.yaml
|
|
examples:
|
|
Conflicting Access Based Policy:
|
|
value:
|
|
id: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde
|
|
name: Conflicting-Policy-Name
|
|
created: '2020-01-01T00:00:00.000000Z'
|
|
modified: '2020-01-01T00:00:00.000000Z'
|
|
description: This policy ensures compliance of xyz
|
|
ownerRef:
|
|
type: IDENTITY
|
|
id: 2c91808568c529c60168cca6f90c1313
|
|
name: Owner Name
|
|
externalPolicyReference: XYZ policy
|
|
policyQuery: '@access(id:2c9180866166b5b0016167c32ef31a66 OR id:2c9180866166b5b0016167c32ef31a67) AND @access(id:2c9180866166b5b0016167c32ef31a68 OR id:2c9180866166b5b0016167c32ef31a69)'
|
|
compensatingControls: Have a manager review the transaction decisions for their "out of compliance" employee
|
|
correctionAdvice: Based on the role of the employee, managers should remove access that is not required for their job function.
|
|
state: ENFORCED
|
|
tags:
|
|
- string
|
|
creatorId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde
|
|
modifierId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde
|
|
violationOwnerAssignmentConfig:
|
|
assignmentRule: MANAGER
|
|
ownerRef:
|
|
type: IDENTITY
|
|
id: 2c91808568c529c60168cca6f90c1313
|
|
name: Violation Owner Name
|
|
scheduled: true
|
|
type: CONFLICTING_ACCESS_BASED
|
|
conflictingAccessCriteria:
|
|
leftCriteria:
|
|
name: money-in
|
|
criteriaList:
|
|
- type: ENTITLEMENT
|
|
id: 2c9180866166b5b0016167c32ef31a66
|
|
- type: ENTITLEMENT
|
|
id: 2c9180866166b5b0016167c32ef31a67
|
|
rightCriteria:
|
|
name: money-out
|
|
criteriaList:
|
|
- type: ENTITLEMENT
|
|
id: 2c9180866166b5b0016167c32ef31a68
|
|
- type: ENTITLEMENT
|
|
id: 2c9180866166b5b0016167c32ef31a69
|
|
General Policy:
|
|
value:
|
|
description: Description
|
|
ownerRef:
|
|
type: IDENTITY
|
|
id: 2c918087682f9a86016839c05e8f1aff
|
|
name: Owner Name
|
|
externalPolicyReference: New policy
|
|
policyQuery: policy query implementation
|
|
compensatingControls: Compensating controls
|
|
correctionAdvice: Correction advice
|
|
tags: []
|
|
state: ENFORCED
|
|
scheduled: false
|
|
creatorId: 2c918087682f9a86016839c05e8f1aff
|
|
modifierId: null
|
|
violationOwnerAssignmentConfig: null
|
|
type: GENERAL
|
|
conflictingAccessCriteria: null
|
|
id: 52c11db4-733e-4c31-949a-766c95ec95f1
|
|
name: General-Policy-Name
|
|
created: '2020-05-12T19:47:38Z'
|
|
modified: '2020-05-12T19:47:38Z'
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve.
|
|
|
|
# Get SOD policy by ID
|
|
|
|
try {
|
|
Get-SodPolicy-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-SodPolicy -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicy"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
put:
|
|
security:
|
|
- userAuth:
|
|
- idn:sod-policy:write
|
|
operationId: putSodPolicy
|
|
tags:
|
|
- SOD Policies
|
|
summary: Update SOD policy by ID
|
|
description: |-
|
|
This updates a specified SOD policy.
|
|
Requires role of ORG_ADMIN.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listSodPolicies
|
|
description: The ID of the SOD policy to update.
|
|
example: ef38f943-47e9-4562-b5bb-8424a56397d8
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1sod-policies/post/requestBody/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/SodPolicy.yaml
|
|
examples:
|
|
Conflicting Access Based Policy:
|
|
value:
|
|
name: Conflicting-Policy-Name
|
|
description: Modified Description
|
|
externalPolicyReference: XYZ policy
|
|
compensatingControls: Have a manager review the transaction decisions for their "out of compliance" employee
|
|
correctionAdvice: Based on the role of the employee, managers should remove access that is not required for their job function.
|
|
state: ENFORCED
|
|
tags:
|
|
- string
|
|
violationOwnerAssignmentConfig:
|
|
assignmentRule: MANAGER
|
|
ownerRef:
|
|
type: IDENTITY
|
|
id: 2c91808568c529c60168cca6f90c1313
|
|
name: Violation Owner Name
|
|
scheduled: true
|
|
type: CONFLICTING_ACCESS_BASED
|
|
conflictingAccessCriteria:
|
|
leftCriteria:
|
|
name: money-in
|
|
criteriaList:
|
|
- type: ENTITLEMENT
|
|
id: 2c9180866166b5b0016167c32ef31a66
|
|
- type: ENTITLEMENT
|
|
id: 2c9180866166b5b0016167c32ef31a67
|
|
rightCriteria:
|
|
name: money-out
|
|
criteriaList:
|
|
- type: ENTITLEMENT
|
|
id: 2c9180866166b5b0016167c32ef31a68
|
|
- type: ENTITLEMENT
|
|
id: 2c9180866166b5b0016167c32ef31a69
|
|
General Policy:
|
|
value:
|
|
description: Modified Description
|
|
ownerRef:
|
|
type: IDENTITY
|
|
id: 2c918087682f9a86016839c05e8f1aff
|
|
name: Owner Name
|
|
externalPolicyReference: New policy
|
|
policyQuery: policy query implementation
|
|
compensatingControls: Compensating controls
|
|
correctionAdvice: Correction advice
|
|
tags: []
|
|
state: ENFORCED
|
|
scheduled: false
|
|
creatorId: 2c918087682f9a86016839c05e8f1aff
|
|
modifierId: null
|
|
violationOwnerAssignmentConfig: null
|
|
type: GENERAL
|
|
conflictingAccessCriteria: null
|
|
id: 52c11db4-733e-4c31-949a-766c95ec95f1
|
|
name: General-Policy-Name
|
|
created: '2020-05-12T19:47:38Z'
|
|
modified: '2020-05-12T19:47:38Z'
|
|
responses:
|
|
'200':
|
|
description: SOD Policy by ID
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1sod-policies/post/requestBody/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/SodPolicy.yaml
|
|
examples:
|
|
Conflicting Access Based Policy:
|
|
value:
|
|
id: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde
|
|
name: Conflicting-Policy-Name
|
|
created: '2020-01-01T00:00:00.000000Z'
|
|
modified: '2020-01-01T00:00:00.000000Z'
|
|
description: Modified description
|
|
ownerRef:
|
|
type: IDENTITY
|
|
id: 2c91808568c529c60168cca6f90c1313
|
|
name: Owner Name
|
|
externalPolicyReference: XYZ policy
|
|
policyQuery: '@access(id:2c9180866166b5b0016167c32ef31a66 OR id:2c9180866166b5b0016167c32ef31a67) AND @access(id:2c9180866166b5b0016167c32ef31a68 OR id:2c9180866166b5b0016167c32ef31a69)'
|
|
compensatingControls: Have a manager review the transaction decisions for their "out of compliance" employee
|
|
correctionAdvice: Based on the role of the employee, managers should remove access that is not required for their job function.
|
|
state: ENFORCED
|
|
tags:
|
|
- string
|
|
creatorId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde
|
|
modifierId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde
|
|
violationOwnerAssignmentConfig:
|
|
assignmentRule: MANAGER
|
|
ownerRef:
|
|
type: IDENTITY
|
|
id: 2c91808568c529c60168cca6f90c1313
|
|
name: Violation Owner Name
|
|
scheduled: true
|
|
type: CONFLICTING_ACCESS_BASED
|
|
conflictingAccessCriteria:
|
|
leftCriteria:
|
|
name: money-in
|
|
criteriaList:
|
|
- type: ENTITLEMENT
|
|
id: 2c9180866166b5b0016167c32ef31a66
|
|
- type: ENTITLEMENT
|
|
id: 2c9180866166b5b0016167c32ef31a67
|
|
rightCriteria:
|
|
name: money-out
|
|
criteriaList:
|
|
- type: ENTITLEMENT
|
|
id: 2c9180866166b5b0016167c32ef31a68
|
|
- type: ENTITLEMENT
|
|
id: 2c9180866166b5b0016167c32ef31a69
|
|
General Policy:
|
|
value:
|
|
description: Modified Description
|
|
ownerRef:
|
|
type: IDENTITY
|
|
id: 2c918087682f9a86016839c05e8f1aff
|
|
name: Owner Name
|
|
externalPolicyReference: New policy
|
|
policyQuery: policy query implementation
|
|
compensatingControls: Compensating controls
|
|
correctionAdvice: Correction advice
|
|
tags: []
|
|
state: ENFORCED
|
|
scheduled: false
|
|
creatorId: 2c918087682f9a86016839c05e8f1aff
|
|
modifierId: null
|
|
violationOwnerAssignmentConfig: null
|
|
type: GENERAL
|
|
conflictingAccessCriteria: null
|
|
id: 52c11db4-733e-4c31-949a-766c95ec95f1
|
|
name: General-Policy-Name
|
|
created: '2020-05-12T19:47:38Z'
|
|
modified: '2020-05-12T19:47:38Z'
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update.
|
|
$SodPolicy = @"
|
|
{
|
|
"conflictingAccessCriteria" : {
|
|
"leftCriteria" : {
|
|
"name" : "money-in",
|
|
"criteriaList" : [ {
|
|
"type" : "ENTITLEMENT",
|
|
"id" : "2c9180866166b5b0016167c32ef31a66",
|
|
"name" : "Administrator"
|
|
}, {
|
|
"type" : "ENTITLEMENT",
|
|
"id" : "2c9180866166b5b0016167c32ef31a67",
|
|
"name" : "Administrator"
|
|
} ]
|
|
},
|
|
"rightCriteria" : {
|
|
"name" : "money-in",
|
|
"criteriaList" : [ {
|
|
"type" : "ENTITLEMENT",
|
|
"id" : "2c9180866166b5b0016167c32ef31a66",
|
|
"name" : "Administrator"
|
|
}, {
|
|
"type" : "ENTITLEMENT",
|
|
"id" : "2c9180866166b5b0016167c32ef31a67",
|
|
"name" : "Administrator"
|
|
} ]
|
|
}
|
|
},
|
|
"ownerRef" : {
|
|
"name" : "Support",
|
|
"id" : "2c9180a46faadee4016fb4e018c20639",
|
|
"type" : "IDENTITY"
|
|
},
|
|
"created" : "2020-01-01T00:00:00Z",
|
|
"scheduled" : true,
|
|
"creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde",
|
|
"modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde",
|
|
"description" : "This policy ensures compliance of xyz",
|
|
"violationOwnerAssignmentConfig" : {
|
|
"assignmentRule" : "MANAGER",
|
|
"ownerRef" : {
|
|
"name" : "Support",
|
|
"id" : "2c9180a46faadee4016fb4e018c20639",
|
|
"type" : "IDENTITY"
|
|
}
|
|
},
|
|
"correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.",
|
|
"type" : "GENERAL",
|
|
"tags" : [ "TAG1", "TAG2" ],
|
|
"name" : "policy-xyz",
|
|
"modified" : "2020-01-01T00:00:00Z",
|
|
"policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)",
|
|
"compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee",
|
|
"id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde",
|
|
"state" : "ENFORCED",
|
|
"externalPolicyReference" : "XYZ policy"
|
|
}
|
|
"@
|
|
|
|
# Update SOD policy by ID
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy
|
|
Send-SodPolicy-Id $Id -SodPolicy $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Send-SodPolicy -Id $Id -SodPolicy $SodPolicy
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SodPolicy"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
delete:
|
|
security:
|
|
- userAuth:
|
|
- idn:sod-policy:write
|
|
operationId: deleteSodPolicy
|
|
tags:
|
|
- SOD Policies
|
|
summary: Delete SOD policy by ID
|
|
description: |-
|
|
This deletes a specified SOD policy.
|
|
Requires role of ORG_ADMIN.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listSodPolicies
|
|
description: The ID of the SOD Policy to delete.
|
|
example: ef38f943-47e9-4562-b5bb-8424a56397d8
|
|
- in: query
|
|
name: logical
|
|
schema:
|
|
type: boolean
|
|
default: true
|
|
description: Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call.
|
|
example: true
|
|
required: false
|
|
responses:
|
|
'204':
|
|
description: No content.
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete.
|
|
$Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true)
|
|
|
|
# Delete SOD policy by ID
|
|
|
|
try {
|
|
Remove-SodPolicy-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Remove-SodPolicy -Id $Id -Logical $Logical
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SodPolicy"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
patch:
|
|
security:
|
|
- userAuth:
|
|
- idn:sod-policy:write
|
|
operationId: patchSodPolicy
|
|
tags:
|
|
- SOD Policies
|
|
summary: Patch SOD policy by ID
|
|
description: |-
|
|
Allows updating SOD Policy fields other than ["id","created","creatorId","policyQuery","type"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
Requires role of ORG_ADMIN.
|
|
This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listSodPolicies
|
|
description: The ID of the SOD policy being modified.
|
|
example: 2c918083-5d19-1a86-015d-28455b4a2329
|
|
requestBody:
|
|
required: true
|
|
description: |
|
|
A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
|
|
The following fields are patchable:
|
|
* name
|
|
* description
|
|
* ownerRef
|
|
* externalPolicyReference
|
|
* compensatingControls
|
|
* correctionAdvice
|
|
* state
|
|
* tags
|
|
* violationOwnerAssignmentConfig
|
|
* scheduled
|
|
* conflictingAccessCriteria
|
|
content:
|
|
application/json-patch+json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/JsonPatchOperation.yaml
|
|
examples:
|
|
Conflicting Access Based Policy:
|
|
value:
|
|
- op: replace
|
|
path: /description
|
|
value: Modified description
|
|
- op: replace
|
|
path: /conflictingAccessCriteria/leftCriteria/name
|
|
value: money-in-modified
|
|
- op: replace
|
|
path: /conflictingAccessCriteria/rightCriteria
|
|
value:
|
|
name: money-out-modified
|
|
criteriaList:
|
|
- type: ENTITLEMENT
|
|
id: 2c918087682f9a86016839c0509c1ab2
|
|
General Policy:
|
|
value:
|
|
- op: replace
|
|
path: /description
|
|
value: Modified description
|
|
responses:
|
|
'200':
|
|
description: Indicates the PATCH operation succeeded, and returns the SOD policy's new representation.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1sod-policies/post/requestBody/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/SodPolicy.yaml
|
|
examples:
|
|
Conflicting Access Based Policy:
|
|
value:
|
|
id: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde
|
|
name: Conflicting-Policy-Name
|
|
created: '2020-01-01T00:00:00.000000Z'
|
|
modified: '2020-01-01T00:00:00.000000Z'
|
|
description: Modified description
|
|
ownerRef:
|
|
type: IDENTITY
|
|
id: 2c91808568c529c60168cca6f90c1313
|
|
name: Owner Name
|
|
externalPolicyReference: XYZ policy
|
|
policyQuery: '@access(id:2c9180866166b5b0016167c32ef31a66 OR id:2c9180866166b5b0016167c32ef31a67) AND @access(id:2c918087682f9a86016839c0509c1ab2)'
|
|
compensatingControls: Have a manager review the transaction decisions for their "out of compliance" employee
|
|
correctionAdvice: Based on the role of the employee, managers should remove access that is not required for their job function.
|
|
state: ENFORCED
|
|
tags:
|
|
- string
|
|
creatorId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde
|
|
modifierId: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde
|
|
violationOwnerAssignmentConfig:
|
|
assignmentRule: MANAGER
|
|
ownerRef:
|
|
type: IDENTITY
|
|
id: 2c91808568c529c60168cca6f90c1313
|
|
name: Violation Owner Name
|
|
scheduled: true
|
|
type: CONFLICTING_ACCESS_BASED
|
|
conflictingAccessCriteria:
|
|
leftCriteria:
|
|
name: money-in-modified
|
|
criteriaList:
|
|
- type: ENTITLEMENT
|
|
id: 2c9180866166b5b0016167c32ef31a66
|
|
- type: ENTITLEMENT
|
|
id: 2c9180866166b5b0016167c32ef31a67
|
|
rightCriteria:
|
|
name: money-out-modified
|
|
criteriaList:
|
|
- type: ENTITLEMENT
|
|
id: 2c918087682f9a86016839c0509c1ab2
|
|
General Policy:
|
|
value:
|
|
description: Modified description
|
|
ownerRef:
|
|
type: IDENTITY
|
|
id: 2c918087682f9a86016839c05e8f1aff
|
|
name: Owner Name
|
|
externalPolicyReference: New policy
|
|
policyQuery: policy query implementation
|
|
compensatingControls: Compensating controls
|
|
correctionAdvice: Correction advice
|
|
tags: []
|
|
state: ENFORCED
|
|
scheduled: false
|
|
creatorId: 2c918087682f9a86016839c05e8f1aff
|
|
modifierId: null
|
|
violationOwnerAssignmentConfig: null
|
|
type: GENERAL
|
|
conflictingAccessCriteria: null
|
|
id: 52c11db4-733e-4c31-949a-766c95ec95f1
|
|
name: General-Policy-Name
|
|
created: '2020-05-12T19:47:38Z'
|
|
modified: '2020-05-12T19:47:38Z'
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified.
|
|
# JsonPatchOperation[] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria
|
|
$JsonPatchOperation = @"{
|
|
"op" : "replace",
|
|
"path" : "/description",
|
|
"value" : "New description"
|
|
}"@
|
|
|
|
|
|
# Patch SOD policy by ID
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
|
|
Update-SodPolicy-Id $Id -JsonPatchOperation $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Update-SodPolicy -Id $Id -JsonPatchOperation $JsonPatchOperation
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SodPolicy"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/sod-policies/{id}/evaluate:
|
|
post:
|
|
security:
|
|
- userAuth:
|
|
- idn:sod-violation:write
|
|
operationId: startEvaluateSodPolicy
|
|
tags:
|
|
- SOD Policies
|
|
summary: Evaluate one policy by ID
|
|
description: Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listSodPolicies
|
|
description: The SOD policy ID to run.
|
|
example: ef38f943-47e9-4562-b5bb-8424a56397d8
|
|
responses:
|
|
'200':
|
|
description: Reference to the violation report run task.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
allOf:
|
|
- type: object
|
|
description: SOD policy violation report result.
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: SOD policy violation report result DTO type.
|
|
enum:
|
|
- REPORT_RESULT
|
|
example: REPORT_RESULT
|
|
id:
|
|
type: string
|
|
description: SOD policy violation report result ID.
|
|
example: 2c9180835d191a86015d28455b4b232a
|
|
name:
|
|
type: string
|
|
description: Human-readable name of the SOD policy violation report result.
|
|
example: SOD Policy 1 Violation
|
|
- type: object
|
|
properties:
|
|
status:
|
|
type: string
|
|
description: Status of a SOD policy violation report.
|
|
enum:
|
|
- SUCCESS
|
|
- WARNING
|
|
- ERROR
|
|
- TERMINATED
|
|
- TEMP_ERROR
|
|
- PENDING
|
|
example: PENDING
|
|
example:
|
|
status: PENDING
|
|
type: REPORT_RESULT
|
|
id: 37b3b32a-f394-46f8-acad-b5223969fa68
|
|
name: Multi Query Report
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run.
|
|
|
|
# Evaluate one policy by ID
|
|
|
|
try {
|
|
Start-EvaluateSodPolicy-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Start-EvaluateSodPolicy -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-EvaluateSodPolicy"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/sod-policies/{id}/schedule:
|
|
get:
|
|
security:
|
|
- userAuth:
|
|
- idn:sod-policy:read
|
|
operationId: getSodPolicySchedule
|
|
tags:
|
|
- SOD Policies
|
|
summary: Get SOD policy schedule
|
|
description: This endpoint gets a specified SOD policy's schedule.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listSodPolicies
|
|
description: The ID of the SOD policy schedule to retrieve.
|
|
example: ef38f943-47e9-4562-b5bb-8424a56397d8
|
|
responses:
|
|
'200':
|
|
description: SOD policy schedule.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: SOD Policy schedule name
|
|
example: SCH-1584312283015
|
|
created:
|
|
type: string
|
|
format: date-time
|
|
description: The time when this SOD policy schedule is created.
|
|
example: '2020-01-01T00:00:00.000000Z'
|
|
readOnly: true
|
|
modified:
|
|
type: string
|
|
format: date-time
|
|
description: The time when this SOD policy schedule is modified.
|
|
example: '2020-01-01T00:00:00.000000Z'
|
|
readOnly: true
|
|
description:
|
|
type: string
|
|
description: SOD Policy schedule description
|
|
example: Schedule for policy xyz
|
|
schedule:
|
|
$ref: '#/components/schemas/ScheduledSearch/allOf/2/properties/schedule'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/schedule/Schedule.yaml
|
|
recipients:
|
|
type: array
|
|
items:
|
|
type: object
|
|
description: SOD policy recipient.
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: SOD policy recipient DTO type.
|
|
enum:
|
|
- IDENTITY
|
|
example: IDENTITY
|
|
id:
|
|
type: string
|
|
description: SOD policy recipient's identity ID.
|
|
example: 2c7180a46faadee4016fb4e018c20642
|
|
name:
|
|
type: string
|
|
description: SOD policy recipient's display name.
|
|
example: Michael Michaels
|
|
emailEmptyResults:
|
|
type: boolean
|
|
description: Indicates if empty results need to be emailed
|
|
example: false
|
|
default: false
|
|
creatorId:
|
|
type: string
|
|
description: Policy's creator ID
|
|
example: 0f11f2a47c944bf3a2bd742580fe3bde
|
|
readOnly: true
|
|
modifierId:
|
|
type: string
|
|
description: Policy's modifier ID
|
|
example: 0f11f2a47c944bf3a2bd742580fe3bde
|
|
readOnly: true
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve.
|
|
|
|
# Get SOD policy schedule
|
|
|
|
try {
|
|
Get-SodPolicySchedule-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-SodPolicySchedule -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicySchedule"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
put:
|
|
security:
|
|
- userAuth:
|
|
- idn:sod-policy:write
|
|
operationId: putPolicySchedule
|
|
tags:
|
|
- SOD Policies
|
|
summary: Update SOD Policy schedule
|
|
description: This updates schedule for a specified SOD policy.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listSodPolicies
|
|
description: The ID of the SOD policy to update its schedule.
|
|
example: ef38f943-47e9-4562-b5bb-8424a56397d8
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1sod-policies~1%7Bid%7D~1schedule/get/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/SodPolicySchedule.yaml
|
|
responses:
|
|
'200':
|
|
description: Created or updated SOD policy schedule.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1sod-policies~1%7Bid%7D~1schedule/get/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/SodPolicySchedule.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule.
|
|
$SodPolicySchedule = @"
|
|
{
|
|
"schedule" : {
|
|
"hours" : {
|
|
"values" : [ "MON", "WED" ],
|
|
"interval" : 3,
|
|
"type" : "LIST"
|
|
},
|
|
"months" : {
|
|
"values" : [ "MON", "WED" ],
|
|
"interval" : 3,
|
|
"type" : "LIST"
|
|
},
|
|
"timeZoneId" : "America/Chicago",
|
|
"days" : {
|
|
"values" : [ "MON", "WED" ],
|
|
"interval" : 3,
|
|
"type" : "LIST"
|
|
},
|
|
"expiration" : "2018-06-25T20:22:28.104Z",
|
|
"type" : "WEEKLY"
|
|
},
|
|
"created" : "2020-01-01T00:00:00Z",
|
|
"recipients" : [ {
|
|
"name" : "Michael Michaels",
|
|
"id" : "2c7180a46faadee4016fb4e018c20642",
|
|
"type" : "IDENTITY"
|
|
}, {
|
|
"name" : "Michael Michaels",
|
|
"id" : "2c7180a46faadee4016fb4e018c20642",
|
|
"type" : "IDENTITY"
|
|
} ],
|
|
"name" : "SCH-1584312283015",
|
|
"creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde",
|
|
"modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde",
|
|
"modified" : "2020-01-01T00:00:00Z",
|
|
"description" : "Schedule for policy xyz",
|
|
"emailEmptyResults" : false
|
|
}
|
|
"@
|
|
|
|
# Update SOD Policy schedule
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule
|
|
Send-PolicySchedule-Id $Id -SodPolicySchedule $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Send-PolicySchedule -Id $Id -SodPolicySchedule $SodPolicySchedule
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-PolicySchedule"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
delete:
|
|
security:
|
|
- userAuth:
|
|
- idn:sod-policy:write
|
|
operationId: deleteSodPolicySchedule
|
|
tags:
|
|
- SOD Policies
|
|
summary: Delete SOD policy schedule
|
|
description: This deletes schedule for a specified SOD policy by ID.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listSodPolicies
|
|
description: The ID of the SOD policy the schedule must be deleted for.
|
|
example: ef38f943-47e9-4562-b5bb-8424a56397d8
|
|
responses:
|
|
'204':
|
|
description: No content response.
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for.
|
|
|
|
# Delete SOD policy schedule
|
|
|
|
try {
|
|
Remove-SodPolicySchedule-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Remove-SodPolicySchedule -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SodPolicySchedule"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/sod-policies/{id}/violation-report/run:
|
|
post:
|
|
security:
|
|
- userAuth:
|
|
- idn:sod-violation:write
|
|
operationId: startSodPolicy
|
|
tags:
|
|
- SOD Policies
|
|
summary: Runs SOD policy violation report
|
|
description: This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listSodPolicies
|
|
description: The SOD policy ID to run.
|
|
example: ef38f943-47e9-4562-b5bb-8424a56397d8
|
|
responses:
|
|
'200':
|
|
description: Reference to the violation report run task.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1sod-policies~1%7Bid%7D~1evaluate/post/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ReportResultReference.yaml
|
|
example:
|
|
status: PENDING
|
|
type: REPORT_RESULT
|
|
id: 2e8d8180-24bc-4d21-91c6-7affdb473b0d
|
|
name: policy-xyz
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run.
|
|
|
|
# Runs SOD policy violation report
|
|
|
|
try {
|
|
Start-SodPolicy-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Start-SodPolicy -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-SodPolicy"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/sod-policies/{id}/violation-report:
|
|
get:
|
|
security:
|
|
- userAuth:
|
|
- idn:sod-violation:read
|
|
operationId: getSodViolationReportStatus
|
|
tags:
|
|
- SOD Policies
|
|
summary: Get SOD violation report status
|
|
description: This gets the status for a violation report run task that has already been invoked.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: startSodPolicy
|
|
description: The ID of the violation report to retrieve status for.
|
|
example: ef38f943-47e9-4562-b5bb-8424a56397d8
|
|
responses:
|
|
'200':
|
|
description: Status of the violation report run task.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1sod-policies~1%7Bid%7D~1evaluate/post/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ReportResultReference.yaml
|
|
example:
|
|
status: SUCCESS
|
|
type: REPORT_RESULT
|
|
id: 2e8d8180-24bc-4d21-91c6-7affdb473b0d
|
|
name: policy-xyz
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for.
|
|
|
|
# Get SOD violation report status
|
|
|
|
try {
|
|
Get-SodViolationReportStatus-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-SodViolationReportStatus -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodViolationReportStatus"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/sod-policies/sod-violation-report-status/{reportResultId}:
|
|
get:
|
|
security:
|
|
- userAuth:
|
|
- idn:sod-violation:read
|
|
operationId: getSodViolationReportRunStatus
|
|
tags:
|
|
- SOD Policies
|
|
summary: Get violation report run status
|
|
description: This gets the status for a violation report run task that has already been invoked.
|
|
parameters:
|
|
- in: path
|
|
name: reportResultId
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getSodAllReportRunStatus
|
|
description: The ID of the report reference to retrieve.
|
|
example: 2e8d8180-24bc-4d21-91c6-7affdb473b0d
|
|
responses:
|
|
'200':
|
|
description: Status of the violation report run task.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1sod-policies~1%7Bid%7D~1evaluate/post/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ReportResultReference.yaml
|
|
example:
|
|
status: SUCCESS
|
|
type: REPORT_RESULT
|
|
id: 2e8d8180-24bc-4d21-91c6-7affdb473b0d
|
|
name: policy-xyz
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve.
|
|
|
|
# Get violation report run status
|
|
|
|
try {
|
|
Get-SodViolationReportRunStatus-ReportResultId $ReportResultId
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-SodViolationReportRunStatus -ReportResultId $ReportResultId
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodViolationReportRunStatus"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/sod-violations/predict:
|
|
post:
|
|
security:
|
|
- userAuth:
|
|
- idn:sod-violation:read
|
|
- applicationAuth:
|
|
- idn:sod-violation:read
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
operationId: startPredictSodViolations
|
|
tags:
|
|
- SOD Violations
|
|
summary: Predict SOD violations for identity.
|
|
description: This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused.
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
description: An identity with a set of access to be added
|
|
required:
|
|
- identityId
|
|
- accessRefs
|
|
type: object
|
|
properties:
|
|
identityId:
|
|
description: Identity id to be checked.
|
|
type: string
|
|
example: 2c91808568c529c60168cca6f90c1313
|
|
accessRefs:
|
|
description: The list of entitlements to consider for possible violations in a preventive check.
|
|
type: array
|
|
items:
|
|
type: object
|
|
description: Entitlement including a specific set of access.
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: Entitlement's DTO type.
|
|
enum:
|
|
- ENTITLEMENT
|
|
example: ENTITLEMENT
|
|
id:
|
|
type: string
|
|
description: Entitlement's ID.
|
|
example: 2c91809773dee32014e13e122092014e
|
|
name:
|
|
type: string
|
|
description: Entitlement's display name.
|
|
example: CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local
|
|
example:
|
|
- type: ENTITLEMENT
|
|
id: 2c918087682f9a86016839c050861ab1
|
|
name: CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local
|
|
- type: ENTITLEMENT
|
|
id: 2c918087682f9a86016839c0509c1ab2
|
|
name: CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local
|
|
example:
|
|
identityId: 2c91808568c529c60168cca6f90c1313
|
|
accessRefs:
|
|
- type: ENTITLEMENT
|
|
id: 2c918087682f9a86016839c050861ab1
|
|
name: CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local
|
|
- type: ENTITLEMENT
|
|
id: 2c918087682f9a86016839c0509c1ab2
|
|
name: CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local
|
|
responses:
|
|
'200':
|
|
description: Violation Contexts
|
|
content:
|
|
application/json:
|
|
schema:
|
|
description: An object containing a listing of the SOD violation reasons detected by this check.
|
|
required:
|
|
- requestId
|
|
type: object
|
|
properties:
|
|
violationContexts:
|
|
type: array
|
|
description: List of Violation Contexts
|
|
items:
|
|
type: object
|
|
properties:
|
|
policy:
|
|
allOf:
|
|
- type: object
|
|
description: SOD policy.
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: SOD policy DTO type.
|
|
enum:
|
|
- SOD_POLICY
|
|
example: SOD_POLICY
|
|
id:
|
|
type: string
|
|
description: SOD policy ID.
|
|
example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde
|
|
name:
|
|
type: string
|
|
description: SOD policy display name.
|
|
example: Business SOD Policy
|
|
- type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: SOD_POLICY
|
|
name:
|
|
type: string
|
|
example: A very cool policy name
|
|
description: The types of objects supported for SOD violations
|
|
properties:
|
|
type:
|
|
enum:
|
|
- ENTITLEMENT
|
|
example: ENTITLEMENT
|
|
description: The type of object that is referenced
|
|
conflictingAccessCriteria:
|
|
type: object
|
|
properties:
|
|
leftCriteria:
|
|
type: object
|
|
properties:
|
|
criteriaList:
|
|
type: array
|
|
description: List of exception criteria. There is a min of 1 and max of 50 items in the list.
|
|
items:
|
|
allOf:
|
|
- type: object
|
|
properties:
|
|
type:
|
|
$ref: '#/components/schemas/AccessProfileSummary/allOf/0/allOf/1/properties/type'
|
|
description: DTO type
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/DtoType.yaml
|
|
id:
|
|
type: string
|
|
description: ID of the object to which this reference applies
|
|
example: 2c91808568c529c60168cca6f90c1313
|
|
name:
|
|
type: string
|
|
description: Human-readable display name of the object to which this reference applies
|
|
example: CN=HelpDesk,OU=test,OU=test-service,DC=TestAD,DC=local
|
|
existing:
|
|
type: boolean
|
|
description: Whether the subject identity already had that access or not
|
|
default: false
|
|
example: true
|
|
description: Access reference with addition of boolean existing flag to indicate whether the access was extant
|
|
description: The types of objects supported for SOD violations
|
|
properties:
|
|
type:
|
|
enum:
|
|
- ENTITLEMENT
|
|
example: ENTITLEMENT
|
|
description: The type of object that is referenced
|
|
example:
|
|
- type: ENTITLEMENT
|
|
id: 2c9180866166b5b0016167c32ef31a66
|
|
existing: true
|
|
- type: ENTITLEMENT
|
|
id: 2c9180866166b5b0016167c32ef31a67
|
|
existing: false
|
|
rightCriteria:
|
|
$ref: '#/paths/~1sod-violations~1predict/post/responses/200/content/application~1json/schema/properties/violationContexts/items/properties/conflictingAccessCriteria/properties/leftCriteria'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/sod/models/ExceptionCriteria.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$IdentityWithNewAccess = @"
|
|
{
|
|
"identityId" : "2c91808568c529c60168cca6f90c1313",
|
|
"accessRefs" : [ {
|
|
"type" : "ENTITLEMENT",
|
|
"id" : "2c918087682f9a86016839c050861ab1",
|
|
"name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local"
|
|
}, {
|
|
"type" : "ENTITLEMENT",
|
|
"id" : "2c918087682f9a86016839c0509c1ab2",
|
|
"name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local"
|
|
} ]
|
|
}
|
|
"@
|
|
|
|
# Predict SOD violations for identity.
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess
|
|
Start-PredictSodViolations-IdentityWithNewAccess $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Start-PredictSodViolations -IdentityWithNewAccess $IdentityWithNewAccess
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-PredictSodViolations"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/sod-violations/check:
|
|
post:
|
|
security:
|
|
- userAuth:
|
|
- idn:sod-violation:read
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
operationId: startViolationCheck
|
|
tags:
|
|
- SOD Violations
|
|
summary: Check SOD violations
|
|
description: This API initiates a SOD policy verification asynchronously.
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
description: An identity with a set of access to be added
|
|
required:
|
|
- identityId
|
|
- accessRefs
|
|
type: object
|
|
properties:
|
|
identityId:
|
|
description: Set of identity IDs to be checked.
|
|
type: string
|
|
example: 2c91809050db617d0150e0bf3215385e
|
|
accessRefs:
|
|
description: The bundle of access profiles to be added to the identities specified. All references must be ENTITLEMENT type.
|
|
type: array
|
|
items:
|
|
allOf:
|
|
- type: object
|
|
description: Entitlement including a specific set of access.
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: Entitlement's DTO type.
|
|
enum:
|
|
- ENTITLEMENT
|
|
example: ENTITLEMENT
|
|
id:
|
|
type: string
|
|
description: Entitlement's ID.
|
|
example: 2c91809773dee32014e13e122092014e
|
|
name:
|
|
type: string
|
|
description: Entitlement's display name.
|
|
example: CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local
|
|
clientMetadata:
|
|
type: object
|
|
additionalProperties:
|
|
type: string
|
|
description: Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check.
|
|
example:
|
|
clientName: client1
|
|
clientId: 2c91808f7892918f0178b78da4a305a1
|
|
example:
|
|
identityId: 2c91808568c529c60168cca6f90c1313
|
|
accessRefs:
|
|
- type: ENTITLEMENT
|
|
id: 2c918087682f9a86016839c050861ab1
|
|
name: CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local
|
|
- type: ENTITLEMENT
|
|
id: 2c918087682f9a86016839c0509c1ab2
|
|
name: CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local
|
|
clientMetadata:
|
|
additionalProp1: string
|
|
additionalProp2: string
|
|
additionalProp3: string
|
|
responses:
|
|
'202':
|
|
description: Request ID with a timestamp.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
description: An object referencing an SOD violation check
|
|
required:
|
|
- requestId
|
|
type: object
|
|
properties:
|
|
requestId:
|
|
description: The id of the original request
|
|
example: 089899f13a8f4da7824996191587bab9
|
|
type: string
|
|
created:
|
|
type: string
|
|
format: date-time
|
|
readOnly: true
|
|
description: The date-time when this request was created.
|
|
example: '2020-01-01T00:00:00.000000Z'
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$IdentityWithNewAccess1 = @"
|
|
{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}
|
|
"@
|
|
|
|
# Check SOD violations
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1
|
|
Start-ViolationCheck-IdentityWithNewAccess1 $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Start-ViolationCheck -IdentityWithNewAccess1 $IdentityWithNewAccess1
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-ViolationCheck"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/sod-violation-report/run:
|
|
post:
|
|
security:
|
|
- userAuth:
|
|
- idn:sod-violation:write
|
|
operationId: startSodAllPoliciesForOrg
|
|
tags:
|
|
- SOD Policies
|
|
summary: Runs all policies for org
|
|
description: Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided.
|
|
requestBody:
|
|
required: false
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
filteredPolicyList:
|
|
type: array
|
|
description: Multi-policy report will be run for this list of ids
|
|
items:
|
|
type: string
|
|
example:
|
|
- b868cd40-ffa4-4337-9c07-1a51846cfa94
|
|
- 63a07a7b-39a4-48aa-956d-50c827deba2a
|
|
example:
|
|
filteredPolicyList:
|
|
- b868cd40-ffa4-4337-9c07-1a51846cfa94
|
|
- 63a07a7b-39a4-48aa-956d-50c827deba2a
|
|
responses:
|
|
'200':
|
|
description: Reference to the violation report run task.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1sod-policies~1%7Bid%7D~1evaluate/post/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ReportResultReference.yaml
|
|
example:
|
|
status: PENDING
|
|
type: REPORT_RESULT
|
|
id: 37b3b32a-f394-46f8-acad-b5223969fa68
|
|
name: Multi Query Report
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$MultiPolicyRequest = @"
|
|
{
|
|
"filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ]
|
|
}
|
|
"@
|
|
|
|
# Runs all policies for org
|
|
|
|
try {
|
|
Start-SodAllPoliciesForOrg
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Start-SodAllPoliciesForOrg -MultiPolicyRequest $MultiPolicyRequest
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-SodAllPoliciesForOrg"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/sod-violation-report:
|
|
get:
|
|
security:
|
|
- userAuth:
|
|
- idn:sod-violation:read
|
|
operationId: getSodAllReportRunStatus
|
|
tags:
|
|
- SOD Policies
|
|
summary: Get multi-report run task status
|
|
description: This endpoint gets the status for a violation report for all policy run.
|
|
responses:
|
|
'200':
|
|
description: Status of the violation report run task for all policy run.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1sod-policies~1%7Bid%7D~1evaluate/post/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ReportResultReference.yaml
|
|
example:
|
|
status: SUCCESS
|
|
type: REPORT_RESULT
|
|
id: 37b3b32a-f394-46f8-acad-b5223969fa68
|
|
name: Multi Query Report
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
|
|
# Get multi-report run task status
|
|
|
|
try {
|
|
Get-SodAllReportRunStatus
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-SodAllReportRunStatus
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodAllReportRunStatus"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/sod-violation-report/{reportResultId}/download:
|
|
get:
|
|
security:
|
|
- userAuth:
|
|
- idn:sod-violation:read
|
|
operationId: getDefaultViolationReport
|
|
tags:
|
|
- SOD Policies
|
|
summary: Download violation report
|
|
description: This allows to download a violation report for a given report reference.
|
|
parameters:
|
|
- in: path
|
|
name: reportResultId
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: startSodPolicy
|
|
description: The ID of the report reference to download.
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
responses:
|
|
'200':
|
|
description: Returns the PolicyReport.zip that contains the violation report file.
|
|
content:
|
|
application/zip:
|
|
schema:
|
|
type: string
|
|
format: binary
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download.
|
|
|
|
# Download violation report
|
|
|
|
try {
|
|
Get-DefaultViolationReport-ReportResultId $ReportResultId
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-DefaultViolationReport -ReportResultId $ReportResultId
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-DefaultViolationReport"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/sod-violation-report/{reportResultId}/download/{fileName}:
|
|
get:
|
|
security:
|
|
- userAuth:
|
|
- idn:sod-violation:read
|
|
operationId: getCustomViolationReport
|
|
tags:
|
|
- SOD Policies
|
|
summary: Download custom violation report
|
|
description: This allows to download a specified named violation report for a given report reference.
|
|
parameters:
|
|
- in: path
|
|
name: reportResultId
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: startSodPolicy
|
|
description: The ID of the report reference to download.
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
- in: path
|
|
name: fileName
|
|
schema:
|
|
type: string
|
|
required: true
|
|
description: Custom Name for the file.
|
|
example: custom-name
|
|
responses:
|
|
'200':
|
|
description: Returns the zip file with given custom name that contains the violation report file.
|
|
content:
|
|
application/zip:
|
|
schema:
|
|
type: string
|
|
format: binary
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download.
|
|
$FileName = "custom-name" # String | Custom Name for the file.
|
|
|
|
# Download custom violation report
|
|
|
|
try {
|
|
Get-CustomViolationReport-ReportResultId $ReportResultId -FileName $FileName
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CustomViolationReport"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/sources:
|
|
get:
|
|
operationId: listSources
|
|
security:
|
|
- userAuth:
|
|
- idn:sources:read
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- SOURCE_ADMIN
|
|
- SOURCE_SUBADMIN
|
|
- ROLE_SUBADMIN
|
|
tags:
|
|
- Sources
|
|
summary: Lists all sources in IdentityNow.
|
|
description: This end-point lists all the sources in IdentityNow.
|
|
parameters:
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
- in: query
|
|
name: filters
|
|
schema:
|
|
type: string
|
|
example: name eq "Employees"
|
|
description: |-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
**id**: *eq, in, ge, gt, le, lt, ne, isnull, sw*
|
|
|
|
**name**: *co, eq, in, sw, ge, gt, ne, isnull*
|
|
|
|
**type**: *eq, in, ge, gt, ne, isnull, sw*
|
|
|
|
**owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw*
|
|
|
|
**features**: *ca, co*
|
|
|
|
**created**: *eq, ge, gt, in, le, lt, ne, isnull, sw*
|
|
|
|
**modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw*
|
|
|
|
**managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw*
|
|
|
|
**description**: *eq, sw*
|
|
|
|
**authoritative**: *eq, ne, isnull*
|
|
|
|
**healthy**: *isnull*
|
|
|
|
**status**: *eq, in, ge, gt, le, lt, ne, isnull, sw*
|
|
|
|
**connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw*
|
|
|
|
**connectorName**: *eq, ge, gt, in, ne, isnull, sw*
|
|
|
|
**category**: *co, eq, ge, gt, in, le, lt, ne, sw*
|
|
- in: query
|
|
name: sorters
|
|
schema:
|
|
type: string
|
|
format: comma-separated
|
|
example: name
|
|
description: |-
|
|
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
|
|
|
Sorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType**
|
|
- in: query
|
|
name: for-subadmin
|
|
schema:
|
|
type: string
|
|
example: name
|
|
description: |-
|
|
Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user.
|
|
Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned.
|
|
- in: query
|
|
name: includeIDNSource
|
|
required: false
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
example: true
|
|
description: Include the IdentityNow source in the response.
|
|
responses:
|
|
'200':
|
|
description: List of Source objects
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
readOnly: true
|
|
description: Source ID.
|
|
example: 2c91808568c529c60168cca6f90c1324
|
|
name:
|
|
type: string
|
|
description: Source's human-readable name.
|
|
example: My Source
|
|
description:
|
|
type: string
|
|
description: Source's human-readable description.
|
|
example: This is the corporate directory.
|
|
owner:
|
|
description: Reference to identity object who owns the source.
|
|
type: object
|
|
properties:
|
|
type:
|
|
description: Type of object being referenced.
|
|
type: string
|
|
enum:
|
|
- IDENTITY
|
|
example: IDENTITY
|
|
id:
|
|
type: string
|
|
description: Owner identity's ID.
|
|
example: 2c91808568c529c60168cca6f90c1313
|
|
name:
|
|
type: string
|
|
description: Owner identity's human-readable display name.
|
|
example: MyName
|
|
cluster:
|
|
description: Reference to the source's associated cluster.
|
|
type: object
|
|
nullable: true
|
|
required:
|
|
- name
|
|
- id
|
|
- type
|
|
properties:
|
|
type:
|
|
description: Type of object being referenced.
|
|
type: string
|
|
enum:
|
|
- CLUSTER
|
|
example: CLUSTER
|
|
id:
|
|
type: string
|
|
description: Cluster ID.
|
|
example: 2c9180866166b5b0016167c32ef31a66
|
|
name:
|
|
type: string
|
|
description: Cluster's human-readable display name.
|
|
example: Corporate Cluster
|
|
accountCorrelationConfig:
|
|
description: Reference to account correlation config object.
|
|
type: object
|
|
nullable: true
|
|
properties:
|
|
type:
|
|
description: Type of object being referenced.
|
|
type: string
|
|
enum:
|
|
- ACCOUNT_CORRELATION_CONFIG
|
|
example: ACCOUNT_CORRELATION_CONFIG
|
|
id:
|
|
type: string
|
|
description: Account correlation config ID.
|
|
example: 2c9180855d191c59015d28583727245a
|
|
name:
|
|
type: string
|
|
description: Account correlation config's human-readable display name.
|
|
example: Directory [source-62867] Account Correlation
|
|
accountCorrelationRule:
|
|
description: Reference to a rule that can do COMPLEX correlation. Only use this rule when you can't use accountCorrelationConfig.
|
|
type: object
|
|
nullable: true
|
|
properties:
|
|
type:
|
|
description: Type of object being referenced.
|
|
type: string
|
|
enum:
|
|
- RULE
|
|
example: RULE
|
|
id:
|
|
type: string
|
|
description: Rule ID.
|
|
example: 2c918085708c274401708c2a8a760001
|
|
name:
|
|
type: string
|
|
description: Rule's human-readable display name.
|
|
example: Example Rule
|
|
managerCorrelationMapping:
|
|
allOf:
|
|
- $ref: '#/components/schemas/Source/properties/managerCorrelationMapping/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ManagerCorrelationMapping.yaml
|
|
- nullable: true
|
|
description: |
|
|
Filter object used during manager correlation to match incoming manager values to an existing manager's
|
|
account/identity.
|
|
managerCorrelationRule:
|
|
description: Reference to the ManagerCorrelationRule. Only use this rule when a simple filter isn't sufficient.
|
|
type: object
|
|
nullable: true
|
|
properties:
|
|
type:
|
|
description: Type of object being referenced.
|
|
type: string
|
|
enum:
|
|
- RULE
|
|
example: RULE
|
|
id:
|
|
type: string
|
|
description: Rule ID.
|
|
example: 2c918085708c274401708c2a8a760001
|
|
name:
|
|
type: string
|
|
description: Rule's human-readable display name.
|
|
example: Example Rule
|
|
beforeProvisioningRule:
|
|
description: 'Rule that runs on the CCG and allows for customization of provisioning plans before the API calls the connector. '
|
|
type: object
|
|
nullable: true
|
|
properties:
|
|
type:
|
|
description: Type of object being referenced.
|
|
type: string
|
|
enum:
|
|
- RULE
|
|
example: RULE
|
|
id:
|
|
type: string
|
|
description: Rule ID.
|
|
example: 2c918085708c274401708c2a8a760001
|
|
name:
|
|
type: string
|
|
description: Rule's human-readable display name.
|
|
example: Example Rule
|
|
schemas:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
description: Type of object being referenced.
|
|
type: string
|
|
enum:
|
|
- CONNECTOR_SCHEMA
|
|
example: CONNECTOR_SCHEMA
|
|
id:
|
|
type: string
|
|
description: Schema ID.
|
|
example: 2c91808568c529c60168cca6f90c1777
|
|
name:
|
|
type: string
|
|
description: Schema's human-readable display name.
|
|
example: MySchema
|
|
description: List of references to schema objects.
|
|
example:
|
|
- type: CONNECTOR_SCHEMA
|
|
id: 2c9180835d191a86015d28455b4b232a
|
|
name: account
|
|
- type: CONNECTOR_SCHEMA
|
|
id: 2c9180835d191a86015d28455b4b232b
|
|
name: group
|
|
passwordPolicies:
|
|
type: array
|
|
nullable: true
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
description: Type of object being referenced.
|
|
type: string
|
|
enum:
|
|
- PASSWORD_POLICY
|
|
example: PASSWORD_POLICY
|
|
id:
|
|
type: string
|
|
description: Policy ID.
|
|
example: 2c91808568c529c60168cca6f90c1777
|
|
name:
|
|
type: string
|
|
description: Policy's human-readable display name.
|
|
example: My Password Policy
|
|
description: List of references to the associated PasswordPolicy objects.
|
|
example:
|
|
- type: PASSWORD_POLICY
|
|
id: 2c9180855d191c59015d291ceb053980
|
|
name: Corporate Password Policy
|
|
- type: PASSWORD_POLICY
|
|
id: 2c9180855d191c59015d291ceb057777
|
|
name: Vendor Password Policy
|
|
features:
|
|
$ref: '#/components/schemas/Source/properties/features'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/SourceFeature.yaml
|
|
type:
|
|
type: string
|
|
description: 'Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. '
|
|
example: OpenLDAP - Direct
|
|
connector:
|
|
type: string
|
|
description: Connector script name.
|
|
example: active-directory
|
|
connectorClass:
|
|
type: string
|
|
description: Fully qualified name of the Java class that implements the connector interface.
|
|
example: sailpoint.connector.LDAPConnector
|
|
connectorAttributes:
|
|
type: object
|
|
description: Connector specific configuration. This configuration will differ from type to type.
|
|
example:
|
|
healthCheckTimeout: 30
|
|
authSearchAttributes:
|
|
- cn
|
|
- uid
|
|
- mail
|
|
deleteThreshold:
|
|
type: integer
|
|
format: int32
|
|
description: Number from 0 to 100 that specifies when to skip the delete phase.
|
|
example: 10
|
|
authoritative:
|
|
type: boolean
|
|
description: When this is true, it indicates that the source is referenced by an identity profile.
|
|
default: false
|
|
example: false
|
|
managementWorkgroup:
|
|
description: Reference to management workgroup for the source.
|
|
type: object
|
|
nullable: true
|
|
properties:
|
|
type:
|
|
description: Type of object being referenced.
|
|
type: string
|
|
enum:
|
|
- GOVERNANCE_GROUP
|
|
example: GOVERNANCE_GROUP
|
|
id:
|
|
type: string
|
|
description: Management workgroup ID.
|
|
example: 2c91808568c529c60168cca6f90c2222
|
|
name:
|
|
type: string
|
|
description: Management workgroup's human-readable display name.
|
|
example: My Management Workgroup
|
|
healthy:
|
|
type: boolean
|
|
description: When this is true, it indicates that the source is healthy.
|
|
default: false
|
|
example: true
|
|
status:
|
|
type: string
|
|
enum:
|
|
- SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT
|
|
- SOURCE_STATE_ERROR_CLUSTER
|
|
- SOURCE_STATE_ERROR_SOURCE
|
|
- SOURCE_STATE_ERROR_VA
|
|
- SOURCE_STATE_FAILURE_CLUSTER
|
|
- SOURCE_STATE_FAILURE_SOURCE
|
|
- SOURCE_STATE_HEALTHY
|
|
- SOURCE_STATE_UNCHECKED_CLUSTER
|
|
- SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES
|
|
- SOURCE_STATE_UNCHECKED_SOURCE
|
|
- SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS
|
|
description: 'Status identifier that gives specific information about why a source is or isn''t healthy. '
|
|
example: SOURCE_STATE_HEALTHY
|
|
since:
|
|
type: string
|
|
description: Timestamp that shows when a source health check was last performed.
|
|
example: '2021-09-28T15:48:29.380Z'
|
|
connectorId:
|
|
type: string
|
|
description: Connector ID
|
|
example: active-directory
|
|
connectorName:
|
|
type: string
|
|
description: Name of the connector that was chosen during source creation.
|
|
example: Active Directory
|
|
connectionType:
|
|
type: string
|
|
description: Type of connection (direct or file).
|
|
example: file
|
|
connectorImplementationId:
|
|
type: string
|
|
description: Connector implementation ID.
|
|
example: delimited-file
|
|
created:
|
|
type: string
|
|
description: Date-time when the source was created
|
|
format: date-time
|
|
example: '2022-02-08T14:50:03.827Z'
|
|
modified:
|
|
type: string
|
|
description: Date-time when the source was last modified.
|
|
format: date-time
|
|
example: '2024-01-23T18:08:50.897Z'
|
|
credentialProviderEnabled:
|
|
type: boolean
|
|
description: If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials.
|
|
default: false
|
|
example: false
|
|
category:
|
|
type: string
|
|
nullable: true
|
|
default: null
|
|
description: Source category (e.g. null, CredentialProvider).
|
|
example: CredentialProvider
|
|
required:
|
|
- name
|
|
- owner
|
|
- connector
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
$Filters = "name eq "Employees"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* (optional)
|
|
$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (optional)
|
|
$ForSubadmin = "name" # String | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional)
|
|
$IncludeIDNSource = $true # Boolean | Include the IdentityNow source in the response. (optional) (default to $false)
|
|
|
|
# Lists all sources in IdentityNow.
|
|
|
|
try {
|
|
Get-Sources
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-Sources -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSubadmin $ForSubadmin -IncludeIDNSource $IncludeIDNSource
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Sources"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
post:
|
|
operationId: createSource
|
|
security:
|
|
- userAuth:
|
|
- idn:sources:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- SOURCE_ADMIN
|
|
- SOURCE_SUBADMIN
|
|
tags:
|
|
- Sources
|
|
summary: Creates a source in IdentityNow.
|
|
description: This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow.
|
|
parameters:
|
|
- in: query
|
|
name: provisionAsCsv
|
|
description: 'If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don''t set this query parameter and you attempt to set the `type` attribute directly, the request won''t correctly generate the source. '
|
|
schema:
|
|
type: boolean
|
|
required: false
|
|
example: false
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1sources/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/Source.yaml
|
|
responses:
|
|
'201':
|
|
description: Created Source object. Any passwords will only show the the encrypted cipher-text, as they are not decrypt-able in IdentityNow cloud-based services, per IdentityNow security design.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1sources/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/Source.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Source = @"
|
|
{
|
|
"cluster" : {
|
|
"name" : "Corporate Cluster",
|
|
"id" : "2c9180866166b5b0016167c32ef31a66",
|
|
"type" : "CLUSTER"
|
|
},
|
|
"deleteThreshold" : 10,
|
|
"connectorId" : "active-directory",
|
|
"description" : "This is the corporate directory.",
|
|
"type" : "OpenLDAP - Direct",
|
|
"connectorClass" : "sailpoint.connector.LDAPConnector",
|
|
"connectionType" : "file",
|
|
"features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ],
|
|
"passwordPolicies" : [ {
|
|
"type" : "PASSWORD_POLICY",
|
|
"id" : "2c9180855d191c59015d291ceb053980",
|
|
"name" : "Corporate Password Policy"
|
|
}, {
|
|
"type" : "PASSWORD_POLICY",
|
|
"id" : "2c9180855d191c59015d291ceb057777",
|
|
"name" : "Vendor Password Policy"
|
|
} ],
|
|
"modified" : "2024-01-23T18:08:50.897Z",
|
|
"id" : "2c91808568c529c60168cca6f90c1324",
|
|
"connectorImplementationId" : "delimited-file",
|
|
"managerCorrelationRule" : {
|
|
"name" : "Example Rule",
|
|
"id" : "2c918085708c274401708c2a8a760001",
|
|
"type" : "RULE"
|
|
},
|
|
"owner" : {
|
|
"name" : "MyName",
|
|
"id" : "2c91808568c529c60168cca6f90c1313",
|
|
"type" : "IDENTITY"
|
|
},
|
|
"managementWorkgroup" : {
|
|
"name" : "My Management Workgroup",
|
|
"id" : "2c91808568c529c60168cca6f90c2222",
|
|
"type" : "GOVERNANCE_GROUP"
|
|
},
|
|
"accountCorrelationRule" : {
|
|
"name" : "Example Rule",
|
|
"id" : "2c918085708c274401708c2a8a760001",
|
|
"type" : "RULE"
|
|
},
|
|
"authoritative" : false,
|
|
"connectorAttributes" : {
|
|
"healthCheckTimeout" : 30,
|
|
"authSearchAttributes" : [ "cn", "uid", "mail" ]
|
|
},
|
|
"created" : "2022-02-08T14:50:03.827Z",
|
|
"managerCorrelationMapping" : {
|
|
"accountAttributeName" : "manager",
|
|
"identityAttributeName" : "manager"
|
|
},
|
|
"credentialProviderEnabled" : false,
|
|
"accountCorrelationConfig" : {
|
|
"name" : "Directory [source-62867] Account Correlation",
|
|
"id" : "2c9180855d191c59015d28583727245a",
|
|
"type" : "ACCOUNT_CORRELATION_CONFIG"
|
|
},
|
|
"connector" : "active-directory",
|
|
"healthy" : true,
|
|
"schemas" : [ {
|
|
"type" : "CONNECTOR_SCHEMA",
|
|
"id" : "2c9180835d191a86015d28455b4b232a",
|
|
"name" : "account"
|
|
}, {
|
|
"type" : "CONNECTOR_SCHEMA",
|
|
"id" : "2c9180835d191a86015d28455b4b232b",
|
|
"name" : "group"
|
|
} ],
|
|
"name" : "My Source",
|
|
"connectorName" : "Active Directory",
|
|
"category" : "CredentialProvider",
|
|
"beforeProvisioningRule" : {
|
|
"name" : "Example Rule",
|
|
"id" : "2c918085708c274401708c2a8a760001",
|
|
"type" : "RULE"
|
|
},
|
|
"status" : "SOURCE_STATE_HEALTHY",
|
|
"since" : "2021-09-28T15:48:29.3801666300Z"
|
|
}
|
|
"@
|
|
$ProvisionAsCsv = $false # Boolean | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional)
|
|
|
|
# Creates a source in IdentityNow.
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToSource -Json $Source
|
|
New-Source-Source $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# New-Source -Source $Source -ProvisionAsCsv $ProvisionAsCsv
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Source"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/sources/{id}:
|
|
get:
|
|
operationId: getSource
|
|
security:
|
|
- userAuth:
|
|
- idn:sources:read
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- SOURCE_ADMIN
|
|
- SOURCE_SUBADMIN
|
|
tags:
|
|
- Sources
|
|
summary: Get Source by ID
|
|
description: Use this API to get a source by a specified ID in Identity Security Cloud (ISC).
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listSources
|
|
description: Source ID.
|
|
example: 2c9180835d191a86015d28455b4a2329
|
|
responses:
|
|
'200':
|
|
description: Source object.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1sources/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/Source.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID.
|
|
|
|
# Get Source by ID
|
|
|
|
try {
|
|
Get-Source-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-Source -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Source"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
put:
|
|
operationId: putSource
|
|
security:
|
|
- userAuth:
|
|
- idn:sources:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- SOURCE_ADMIN
|
|
- SOURCE_SUBADMIN
|
|
tags:
|
|
- Sources
|
|
summary: Update Source (Full)
|
|
description: |
|
|
Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration.
|
|
|
|
These fields are immutable, so they cannot be changed:
|
|
|
|
* id
|
|
* type
|
|
* authoritative
|
|
* connector
|
|
* connectorClass
|
|
* passwordPolicies
|
|
|
|
Attempts to modify these fields will result in a 400 error.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listSources
|
|
description: Source ID.
|
|
example: 2c9180835d191a86015d28455b4a2329
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1sources/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/Source.yaml
|
|
responses:
|
|
'200':
|
|
description: Updated Source object. Any passwords will only show the the encrypted cipher-text so that they aren't decryptable in Identity Security Cloud (ISC) cloud-based services, per ISC security design.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1sources/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/Source.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID.
|
|
$Source = @"
|
|
{
|
|
"cluster" : {
|
|
"name" : "Corporate Cluster",
|
|
"id" : "2c9180866166b5b0016167c32ef31a66",
|
|
"type" : "CLUSTER"
|
|
},
|
|
"deleteThreshold" : 10,
|
|
"connectorId" : "active-directory",
|
|
"description" : "This is the corporate directory.",
|
|
"type" : "OpenLDAP - Direct",
|
|
"connectorClass" : "sailpoint.connector.LDAPConnector",
|
|
"connectionType" : "file",
|
|
"features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ],
|
|
"passwordPolicies" : [ {
|
|
"type" : "PASSWORD_POLICY",
|
|
"id" : "2c9180855d191c59015d291ceb053980",
|
|
"name" : "Corporate Password Policy"
|
|
}, {
|
|
"type" : "PASSWORD_POLICY",
|
|
"id" : "2c9180855d191c59015d291ceb057777",
|
|
"name" : "Vendor Password Policy"
|
|
} ],
|
|
"modified" : "2024-01-23T18:08:50.897Z",
|
|
"id" : "2c91808568c529c60168cca6f90c1324",
|
|
"connectorImplementationId" : "delimited-file",
|
|
"managerCorrelationRule" : {
|
|
"name" : "Example Rule",
|
|
"id" : "2c918085708c274401708c2a8a760001",
|
|
"type" : "RULE"
|
|
},
|
|
"owner" : {
|
|
"name" : "MyName",
|
|
"id" : "2c91808568c529c60168cca6f90c1313",
|
|
"type" : "IDENTITY"
|
|
},
|
|
"managementWorkgroup" : {
|
|
"name" : "My Management Workgroup",
|
|
"id" : "2c91808568c529c60168cca6f90c2222",
|
|
"type" : "GOVERNANCE_GROUP"
|
|
},
|
|
"accountCorrelationRule" : {
|
|
"name" : "Example Rule",
|
|
"id" : "2c918085708c274401708c2a8a760001",
|
|
"type" : "RULE"
|
|
},
|
|
"authoritative" : false,
|
|
"connectorAttributes" : {
|
|
"healthCheckTimeout" : 30,
|
|
"authSearchAttributes" : [ "cn", "uid", "mail" ]
|
|
},
|
|
"created" : "2022-02-08T14:50:03.827Z",
|
|
"managerCorrelationMapping" : {
|
|
"accountAttributeName" : "manager",
|
|
"identityAttributeName" : "manager"
|
|
},
|
|
"credentialProviderEnabled" : false,
|
|
"accountCorrelationConfig" : {
|
|
"name" : "Directory [source-62867] Account Correlation",
|
|
"id" : "2c9180855d191c59015d28583727245a",
|
|
"type" : "ACCOUNT_CORRELATION_CONFIG"
|
|
},
|
|
"connector" : "active-directory",
|
|
"healthy" : true,
|
|
"schemas" : [ {
|
|
"type" : "CONNECTOR_SCHEMA",
|
|
"id" : "2c9180835d191a86015d28455b4b232a",
|
|
"name" : "account"
|
|
}, {
|
|
"type" : "CONNECTOR_SCHEMA",
|
|
"id" : "2c9180835d191a86015d28455b4b232b",
|
|
"name" : "group"
|
|
} ],
|
|
"name" : "My Source",
|
|
"connectorName" : "Active Directory",
|
|
"category" : "CredentialProvider",
|
|
"beforeProvisioningRule" : {
|
|
"name" : "Example Rule",
|
|
"id" : "2c918085708c274401708c2a8a760001",
|
|
"type" : "RULE"
|
|
},
|
|
"status" : "SOURCE_STATE_HEALTHY",
|
|
"since" : "2021-09-28T15:48:29.3801666300Z"
|
|
}
|
|
"@
|
|
|
|
# Update Source (Full)
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToSource -Json $Source
|
|
Send-Source-Id $Id -Source $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Send-Source -Id $Id -Source $Source
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-Source"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
patch:
|
|
operationId: updateSource
|
|
security:
|
|
- userAuth:
|
|
- idn:sources:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- SOURCE_ADMIN
|
|
- SOURCE_SUBADMIN
|
|
tags:
|
|
- Sources
|
|
summary: Update Source (Partial)
|
|
description: |
|
|
Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the
|
|
[JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
|
|
These fields are immutable, so they cannot be changed:
|
|
|
|
* id
|
|
* type
|
|
* authoritative
|
|
* created
|
|
* modified
|
|
* connector
|
|
* connectorClass
|
|
* passwordPolicies
|
|
|
|
Attempts to modify these fields will result in a 400 error.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listSources
|
|
description: Source ID.
|
|
example: 2c9180835d191a86015d28455b4a2329
|
|
requestBody:
|
|
required: true
|
|
description: A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC).
|
|
content:
|
|
application/json-patch+json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/JsonPatchOperation.yaml
|
|
examples:
|
|
Edit the source description:
|
|
description: This example shows how to edit a source description.
|
|
value:
|
|
- op: replace
|
|
path: /description
|
|
value: new description
|
|
Edit the source cluster:
|
|
description: This example shows how to edit a source cluster by ID.
|
|
value:
|
|
- op: replace
|
|
path: /cluster/id
|
|
value: 2c918087813a902001813f3f85736b45
|
|
Edit source features:
|
|
description: This example illustrates how you can update source supported features.
|
|
value:
|
|
- op: replace
|
|
path: /features
|
|
value:
|
|
- PASSWORD
|
|
- PROVISIONING
|
|
- ENABLE
|
|
- AUTHENTICATE
|
|
Change a source description and cluster in one call:
|
|
description: This example shows how multiple fields may be updated with a single PATCH call.
|
|
value:
|
|
- op: replace
|
|
path: /description
|
|
value: new description
|
|
- op: replace
|
|
path: /cluster/id
|
|
value: 2c918087813a902001813f3f85736b45
|
|
Add a filter string to the connector:
|
|
description: This example shows how you can add a filter to incoming accounts during the account aggregation process. In the example, any account that does not have an "m" or "d" in the ID will be aggregated.
|
|
value:
|
|
- op: add
|
|
path: /connectorAttributes/filterString
|
|
value: '!( id.contains( "m" ) ) || !( id.contains( "d" ) )'
|
|
Update connector attribute for specific operation type:
|
|
description: This example shows how you can update the 3rd object in the connection parameter's `operationType`. This changes it from a standard group aggregation to a group aggregation on the "test" entitlement type.
|
|
value:
|
|
- op: replace
|
|
path: /connectorAttributes/connectionParameters/2/operationType
|
|
value: Group Aggregation-test
|
|
Enable notifications for new account provisioning on a source:
|
|
description: This example shows how you can configure and enable email notifications that will send when new accounts are provisioned on a source.
|
|
value:
|
|
- op: replace
|
|
path: /connectorAttributes/accountCreateNotification
|
|
value:
|
|
notifyList:
|
|
- Distribution.list@demo.com
|
|
notifyAccountOwner: true
|
|
enabled: true
|
|
notifyAccountOwnerAltEmail: false
|
|
responses:
|
|
'200':
|
|
description: Updated Source object. Any passwords will only show the the encrypted cipher-text so that they aren't decryptable in Identity Security Cloud (ISC) cloud-based services, per ISC security design.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1sources/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/Source.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID.
|
|
# JsonPatchOperation[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC).
|
|
$JsonPatchOperation = @"{
|
|
"op" : "replace",
|
|
"path" : "/description",
|
|
"value" : "New description"
|
|
}"@
|
|
|
|
|
|
# Update Source (Partial)
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
|
|
Update-Source-Id $Id -JsonPatchOperation $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Update-Source -Id $Id -JsonPatchOperation $JsonPatchOperation
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Source"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
delete:
|
|
operationId: deleteSource
|
|
security:
|
|
- userAuth:
|
|
- idn:sources:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- SOURCE_ADMIN
|
|
- SOURCE_SUBADMIN
|
|
tags:
|
|
- Sources
|
|
summary: Delete Source by ID
|
|
description: |-
|
|
Use this API to delete a specific source in Identity Security Cloud (ISC).
|
|
The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}`
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listSources
|
|
description: Source ID.
|
|
example: 2c9180835d191a86015d28455b4a2329
|
|
responses:
|
|
'202':
|
|
description: Accepted - Returned if the request was successfully accepted into the system.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
type:
|
|
description: Type of object being referenced.
|
|
type: string
|
|
enum:
|
|
- TASK_RESULT
|
|
example: TASK_RESULT
|
|
id:
|
|
type: string
|
|
description: Task result ID.
|
|
example: 2c91808779ecf55b0179f720942f181a
|
|
name:
|
|
type: string
|
|
description: Task result's human-readable display name (this should be null/empty).
|
|
example: null
|
|
examples:
|
|
deleteSource:
|
|
summary: Response returned when a source is being deleted.
|
|
value:
|
|
type: TASK_RESULT
|
|
id: 2c91808779ecf55b0179f720942f181a
|
|
name: null
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID.
|
|
|
|
# Delete Source by ID
|
|
|
|
try {
|
|
Remove-Source-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Remove-Source -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Source"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/sources/{sourceId}/provisioning-policies:
|
|
get:
|
|
operationId: listProvisioningPolicies
|
|
tags:
|
|
- Sources
|
|
summary: Lists ProvisioningPolicies
|
|
description: This end-point lists all the ProvisioningPolicies in IdentityNow.
|
|
security:
|
|
- userAuth:
|
|
- idn:provisioning-policy:read
|
|
- idn:provisioning-policy:manage
|
|
- applicationAuth:
|
|
- idn:provisioning-policy:read
|
|
- idn:provisioning-policy:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
parameters:
|
|
- in: path
|
|
name: sourceId
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listSources
|
|
schema:
|
|
type: string
|
|
description: The Source id
|
|
example: 2c9180835d191a86015d28455b4a2329
|
|
responses:
|
|
'200':
|
|
description: List of ProvisioningPolicyDto objects
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
required:
|
|
- name
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: the provisioning policy name
|
|
example: example provisioning policy for inactive identities
|
|
description:
|
|
type: string
|
|
description: the description of the provisioning policy
|
|
example: this provisioning policy creates access based on an identity going inactive
|
|
usageType:
|
|
$ref: '#/components/schemas/ProvisioningPolicy/properties/usageType'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/UsageType.yaml
|
|
fields:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/ProvisioningPolicy/properties/fields/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/FieldDetailsDto.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id
|
|
|
|
# Lists ProvisioningPolicies
|
|
|
|
try {
|
|
Get-ProvisioningPolicies-SourceId $SourceId
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-ProvisioningPolicies -SourceId $SourceId
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ProvisioningPolicies"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
post:
|
|
operationId: createProvisioningPolicy
|
|
tags:
|
|
- Sources
|
|
summary: Create Provisioning Policy
|
|
description: |-
|
|
This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types.
|
|
Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning.
|
|
Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information.
|
|
security:
|
|
- userAuth:
|
|
- idn:provisioning-policy:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
parameters:
|
|
- in: path
|
|
name: sourceId
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listSources
|
|
schema:
|
|
type: string
|
|
description: The Source id
|
|
example: 2c9180835d191a86015d28455b4a2329
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1sources~1%7BsourceId%7D~1provisioning-policies/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ProvisioningPolicyDto.yaml
|
|
examples:
|
|
Create Account Provisioning Policy:
|
|
value:
|
|
name: Account
|
|
description: Account Provisioning Policy
|
|
usageType: CREATE
|
|
fields:
|
|
- name: displayName
|
|
transform:
|
|
type: identityAttribute
|
|
attributes:
|
|
name: displayName
|
|
attributes: {}
|
|
isRequired: false
|
|
type: string
|
|
isMultiValued: false
|
|
- name: distinguishedName
|
|
transform:
|
|
type: usernameGenerator
|
|
attributes:
|
|
sourceCheck: true
|
|
patterns:
|
|
- CN=$fi $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com
|
|
- CN=$fti $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com
|
|
- CN=$fn $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com
|
|
- CN=$fn$ln${uniqueCounter},OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com
|
|
fn:
|
|
type: identityAttribute
|
|
attributes:
|
|
name: firstname
|
|
ln:
|
|
type: identityAttribute
|
|
attributes:
|
|
name: lastname
|
|
fi:
|
|
type: substring
|
|
attributes:
|
|
input:
|
|
type: identityAttribute
|
|
attributes:
|
|
name: firstname
|
|
begin: 0
|
|
end: 1
|
|
fti:
|
|
type: substring
|
|
attributes:
|
|
input:
|
|
type: identityAttribute
|
|
attributes:
|
|
name: firstname
|
|
begin: 0
|
|
end: 2
|
|
attributes:
|
|
cloudMaxUniqueChecks: '5'
|
|
cloudMaxSize: '100'
|
|
cloudRequired: 'true'
|
|
isRequired: false
|
|
type: ''
|
|
isMultiValued: false
|
|
- name: description
|
|
transform:
|
|
type: static
|
|
attributes:
|
|
value: ''
|
|
attributes: {}
|
|
isRequired: false
|
|
type: string
|
|
isMultiValued: false
|
|
responses:
|
|
'201':
|
|
description: Created ProvisioningPolicyDto object
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1sources~1%7BsourceId%7D~1provisioning-policies/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ProvisioningPolicyDto.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id
|
|
$ProvisioningPolicyDto = @"
|
|
{
|
|
"name" : "example provisioning policy for inactive identities",
|
|
"description" : "this provisioning policy creates access based on an identity going inactive",
|
|
"fields" : [ {
|
|
"isRequired" : false,
|
|
"transform" : {
|
|
"type" : "rule",
|
|
"attributes" : {
|
|
"name" : "Create Unique LDAP Attribute"
|
|
}
|
|
},
|
|
"isMultiValued" : false,
|
|
"name" : "userName",
|
|
"attributes" : {
|
|
"template" : "${firstname}.${lastname}${uniqueCounter}",
|
|
"cloudMaxUniqueChecks" : "50",
|
|
"cloudMaxSize" : "20",
|
|
"cloudRequired" : "true"
|
|
},
|
|
"type" : "string"
|
|
}, {
|
|
"isRequired" : false,
|
|
"transform" : {
|
|
"type" : "rule",
|
|
"attributes" : {
|
|
"name" : "Create Unique LDAP Attribute"
|
|
}
|
|
},
|
|
"isMultiValued" : false,
|
|
"name" : "userName",
|
|
"attributes" : {
|
|
"template" : "${firstname}.${lastname}${uniqueCounter}",
|
|
"cloudMaxUniqueChecks" : "50",
|
|
"cloudMaxSize" : "20",
|
|
"cloudRequired" : "true"
|
|
},
|
|
"type" : "string"
|
|
} ],
|
|
"usageType" : "CREATE"
|
|
}
|
|
"@
|
|
|
|
# Create Provisioning Policy
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto
|
|
New-ProvisioningPolicy-SourceId $SourceId -ProvisioningPolicyDto $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# New-ProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $ProvisioningPolicyDto
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ProvisioningPolicy"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/sources/{sourceId}/provisioning-policies/{usageType}:
|
|
get:
|
|
operationId: getProvisioningPolicy
|
|
tags:
|
|
- Sources
|
|
summary: Get Provisioning Policy by UsageType
|
|
description: This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow.
|
|
security:
|
|
- userAuth:
|
|
- idn:provisioning-policy:read
|
|
- idn:provisioning-policy-source:read
|
|
- idn:provisioning-policy:manage
|
|
- idn:provisioning-policy-source-admin-operations:manage
|
|
- applicationAuth:
|
|
- idn:provisioning-policy:read
|
|
- idn:provisioning-policy-source:read
|
|
- idn:provisioning-policy:manage
|
|
- idn:provisioning-policy-source-admin-operations:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- SOURCE_ADMIN
|
|
- SOURCE_SUBADMIN
|
|
parameters:
|
|
- in: path
|
|
name: sourceId
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listSources
|
|
schema:
|
|
type: string
|
|
description: The Source ID.
|
|
example: 2c9180835d191a86015d28455b4a2329
|
|
- in: path
|
|
name: usageType
|
|
required: true
|
|
description: |-
|
|
The type of provisioning policy usage.
|
|
In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined.
|
|
These are the common usage types:
|
|
CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source.
|
|
UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source.
|
|
ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created.
|
|
DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source.
|
|
You can use these four usage types for all your provisioning policy needs.
|
|
example: CREATE
|
|
schema:
|
|
$ref: '#/components/schemas/ProvisioningPolicy/properties/usageType'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/UsageType.yaml
|
|
responses:
|
|
'200':
|
|
description: The requested ProvisioningPolicyDto was successfully retrieved.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1sources~1%7BsourceId%7D~1provisioning-policies/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ProvisioningPolicyDto.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID.
|
|
$UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.
|
|
|
|
# Get Provisioning Policy by UsageType
|
|
|
|
try {
|
|
Get-ProvisioningPolicy-SourceId $SourceId -UsageType $UsageType
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ProvisioningPolicy"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
put:
|
|
operationId: putProvisioningPolicy
|
|
tags:
|
|
- Sources
|
|
summary: Update Provisioning Policy by UsageType
|
|
description: |-
|
|
This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow.
|
|
Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning.
|
|
Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information.
|
|
security:
|
|
- userAuth:
|
|
- idn:provisioning-policy:manage
|
|
- idn:provisioning-policy-source-admin-operations:manage
|
|
- applicationAuth:
|
|
- idn:provisioning-policy:manage
|
|
- idn:provisioning-policy-source-admin-operations:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- SOURCE_ADMIN
|
|
- SOURCE_SUBADMIN
|
|
parameters:
|
|
- in: path
|
|
name: sourceId
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listSources
|
|
schema:
|
|
type: string
|
|
description: The Source ID.
|
|
example: 2c9180835d191a86015d28455b4a2329
|
|
- in: path
|
|
name: usageType
|
|
required: true
|
|
description: |-
|
|
The type of provisioning policy usage.
|
|
In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined.
|
|
These are the common usage types:
|
|
CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source.
|
|
UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source.
|
|
ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created.
|
|
DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source.
|
|
You can use these four usage types for all your provisioning policy needs.
|
|
example: CREATE
|
|
schema:
|
|
$ref: '#/components/schemas/ProvisioningPolicy/properties/usageType'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/UsageType.yaml
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1sources~1%7BsourceId%7D~1provisioning-policies/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ProvisioningPolicyDto.yaml
|
|
responses:
|
|
'200':
|
|
description: The ProvisioningPolicyDto was successfully replaced.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1sources~1%7BsourceId%7D~1provisioning-policies/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ProvisioningPolicyDto.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID.
|
|
$UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.
|
|
$ProvisioningPolicyDto = @"
|
|
{
|
|
"name" : "example provisioning policy for inactive identities",
|
|
"description" : "this provisioning policy creates access based on an identity going inactive",
|
|
"fields" : [ {
|
|
"isRequired" : false,
|
|
"transform" : {
|
|
"type" : "rule",
|
|
"attributes" : {
|
|
"name" : "Create Unique LDAP Attribute"
|
|
}
|
|
},
|
|
"isMultiValued" : false,
|
|
"name" : "userName",
|
|
"attributes" : {
|
|
"template" : "${firstname}.${lastname}${uniqueCounter}",
|
|
"cloudMaxUniqueChecks" : "50",
|
|
"cloudMaxSize" : "20",
|
|
"cloudRequired" : "true"
|
|
},
|
|
"type" : "string"
|
|
}, {
|
|
"isRequired" : false,
|
|
"transform" : {
|
|
"type" : "rule",
|
|
"attributes" : {
|
|
"name" : "Create Unique LDAP Attribute"
|
|
}
|
|
},
|
|
"isMultiValued" : false,
|
|
"name" : "userName",
|
|
"attributes" : {
|
|
"template" : "${firstname}.${lastname}${uniqueCounter}",
|
|
"cloudMaxUniqueChecks" : "50",
|
|
"cloudMaxSize" : "20",
|
|
"cloudRequired" : "true"
|
|
},
|
|
"type" : "string"
|
|
} ],
|
|
"usageType" : "CREATE"
|
|
}
|
|
"@
|
|
|
|
# Update Provisioning Policy by UsageType
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto
|
|
Send-ProvisioningPolicy-SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Send-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $ProvisioningPolicyDto
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ProvisioningPolicy"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
patch:
|
|
operationId: updateProvisioningPolicy
|
|
tags:
|
|
- Sources
|
|
summary: Partial update of Provisioning Policy
|
|
description: |-
|
|
This API selectively updates an existing Provisioning Policy using a JSONPatch payload.
|
|
Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning.
|
|
Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information.
|
|
security:
|
|
- userAuth:
|
|
- idn:provisioning-policy:update
|
|
- applicationAuth:
|
|
- idn:provisioning-policy:update
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- SOURCE_ADMIN
|
|
- SOURCE_SUBADMIN
|
|
parameters:
|
|
- in: path
|
|
name: sourceId
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listSources
|
|
schema:
|
|
type: string
|
|
description: The Source id.
|
|
example: 2c9180835d191a86015d28455b4a2329
|
|
- in: path
|
|
name: usageType
|
|
required: true
|
|
description: |-
|
|
The type of provisioning policy usage.
|
|
In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined.
|
|
These are the common usage types:
|
|
CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source.
|
|
UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source.
|
|
ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created.
|
|
DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source.
|
|
You can use these four usage types for all your provisioning policy needs.
|
|
example: CREATE
|
|
schema:
|
|
$ref: '#/components/schemas/ProvisioningPolicy/properties/usageType'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/UsageType.yaml
|
|
requestBody:
|
|
required: true
|
|
description: The JSONPatch payload used to update the schema.
|
|
content:
|
|
application/json-patch+json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/JsonPatchOperation.yaml
|
|
examples:
|
|
add-field:
|
|
summary: Add a field to the beginning of the list
|
|
value:
|
|
- op: add
|
|
path: /fields/0
|
|
value:
|
|
name: email
|
|
transform:
|
|
type: identityAttribute
|
|
attributes:
|
|
name: email
|
|
attributes: {}
|
|
isRequired: false
|
|
type: string
|
|
isMultiValued: false
|
|
responses:
|
|
'200':
|
|
description: The ProvisioningPolicyDto was successfully updated.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1sources~1%7BsourceId%7D~1provisioning-policies/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ProvisioningPolicyDto.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id.
|
|
$UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.
|
|
# JsonPatchOperation[] | The JSONPatch payload used to update the schema.
|
|
$JsonPatchOperation = @"{
|
|
"op" : "replace",
|
|
"path" : "/description",
|
|
"value" : "New description"
|
|
}"@
|
|
|
|
|
|
# Partial update of Provisioning Policy
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
|
|
Update-ProvisioningPolicy-SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Update-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $JsonPatchOperation
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ProvisioningPolicy"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
delete:
|
|
operationId: deleteProvisioningPolicy
|
|
tags:
|
|
- Sources
|
|
summary: Delete Provisioning Policy by UsageType
|
|
description: Deletes the provisioning policy with the specified usage on an application.
|
|
security:
|
|
- userAuth:
|
|
- idn:provisioning-policy:manage
|
|
- applicationAuth:
|
|
- idn:provisioning-policy:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
parameters:
|
|
- in: path
|
|
name: sourceId
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listSources
|
|
schema:
|
|
type: string
|
|
description: The Source ID.
|
|
example: 2c9180835d191a86015d28455b4a2329
|
|
- in: path
|
|
name: usageType
|
|
required: true
|
|
description: |-
|
|
The type of provisioning policy usage.
|
|
In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined.
|
|
These are the common usage types:
|
|
CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source.
|
|
UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source.
|
|
ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created.
|
|
DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source.
|
|
You can use these four usage types for all your provisioning policy needs.
|
|
example: CREATE
|
|
schema:
|
|
$ref: '#/components/schemas/ProvisioningPolicy/properties/usageType'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/UsageType.yaml
|
|
responses:
|
|
'204':
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/204.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID.
|
|
$UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.
|
|
|
|
# Delete Provisioning Policy by UsageType
|
|
|
|
try {
|
|
Remove-ProvisioningPolicy-SourceId $SourceId -UsageType $UsageType
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Remove-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ProvisioningPolicy"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/sources/{sourceId}/provisioning-policies/bulk-update:
|
|
post:
|
|
operationId: updateProvisioningPoliciesInBulk
|
|
tags:
|
|
- Sources
|
|
summary: Bulk Update Provisioning Policies
|
|
description: This end-point updates a list of provisioning policies on the specified source in IdentityNow.
|
|
security:
|
|
- userAuth:
|
|
- idn:provisioning-policy:manage
|
|
- applicationAuth:
|
|
- idn:provisioning-policy:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
parameters:
|
|
- in: path
|
|
name: sourceId
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listSources
|
|
schema:
|
|
type: string
|
|
description: The Source id.
|
|
example: 2c9180835d191a86015d28455b4a2329
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1sources~1%7BsourceId%7D~1provisioning-policies/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ProvisioningPolicyDto.yaml
|
|
responses:
|
|
'200':
|
|
description: A list of the ProvisioningPolicyDto was successfully replaced.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1sources~1%7BsourceId%7D~1provisioning-policies/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ProvisioningPolicyDto.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id.
|
|
# ProvisioningPolicyDto[] |
|
|
$ProvisioningPolicyDto = @"{
|
|
"name" : "example provisioning policy for inactive identities",
|
|
"description" : "this provisioning policy creates access based on an identity going inactive",
|
|
"fields" : [ {
|
|
"isRequired" : false,
|
|
"transform" : {
|
|
"type" : "rule",
|
|
"attributes" : {
|
|
"name" : "Create Unique LDAP Attribute"
|
|
}
|
|
},
|
|
"isMultiValued" : false,
|
|
"name" : "userName",
|
|
"attributes" : {
|
|
"template" : "${firstname}.${lastname}${uniqueCounter}",
|
|
"cloudMaxUniqueChecks" : "50",
|
|
"cloudMaxSize" : "20",
|
|
"cloudRequired" : "true"
|
|
},
|
|
"type" : "string"
|
|
}, {
|
|
"isRequired" : false,
|
|
"transform" : {
|
|
"type" : "rule",
|
|
"attributes" : {
|
|
"name" : "Create Unique LDAP Attribute"
|
|
}
|
|
},
|
|
"isMultiValued" : false,
|
|
"name" : "userName",
|
|
"attributes" : {
|
|
"template" : "${firstname}.${lastname}${uniqueCounter}",
|
|
"cloudMaxUniqueChecks" : "50",
|
|
"cloudMaxSize" : "20",
|
|
"cloudRequired" : "true"
|
|
},
|
|
"type" : "string"
|
|
} ],
|
|
"usageType" : "CREATE"
|
|
}"@
|
|
|
|
|
|
# Bulk Update Provisioning Policies
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto
|
|
Update-ProvisioningPoliciesInBulk-SourceId $SourceId -ProvisioningPolicyDto $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Update-ProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $ProvisioningPolicyDto
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ProvisioningPoliciesInBulk"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/sources/{sourceId}/schemas:
|
|
get:
|
|
operationId: getSourceSchemas
|
|
security:
|
|
- userAuth:
|
|
- idn:source-schema:read
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- SOURCE_ADMIN
|
|
- SOURCE_SUBADMIN
|
|
tags:
|
|
- Sources
|
|
summary: List Schemas on Source
|
|
description: Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC).
|
|
parameters:
|
|
- in: path
|
|
name: sourceId
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listSources
|
|
schema:
|
|
type: string
|
|
description: Source ID.
|
|
example: 2c9180835d191a86015d28455b4a2329
|
|
- in: query
|
|
name: include-types
|
|
required: false
|
|
schema:
|
|
type: string
|
|
enum:
|
|
- group
|
|
- user
|
|
description: |-
|
|
If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently.
|
|
Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas.
|
|
example: group
|
|
- in: query
|
|
name: include-names
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: A comma-separated list of schema names to filter result.
|
|
example: account
|
|
responses:
|
|
'200':
|
|
description: The schemas were successfully retrieved.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The id of the Schema.
|
|
example: 2c9180835d191a86015d28455b4a2329
|
|
name:
|
|
type: string
|
|
description: The name of the Schema.
|
|
example: account
|
|
nativeObjectType:
|
|
type: string
|
|
description: The name of the object type on the native system that the schema represents.
|
|
example: User
|
|
identityAttribute:
|
|
type: string
|
|
description: The name of the attribute used to calculate the unique identifier for an object in the schema.
|
|
example: sAMAccountName
|
|
displayAttribute:
|
|
type: string
|
|
description: The name of the attribute used to calculate the display value for an object in the schema.
|
|
example: distinguishedName
|
|
hierarchyAttribute:
|
|
type: string
|
|
description: The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas.
|
|
example: memberOf
|
|
includePermissions:
|
|
type: boolean
|
|
description: Flag indicating whether or not the include permissions with the object data when aggregating the schema.
|
|
example: false
|
|
features:
|
|
$ref: '#/components/schemas/Source/properties/features'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/SourceFeature.yaml
|
|
configuration:
|
|
type: object
|
|
description: Holds any extra configuration data that the schema may require.
|
|
example:
|
|
groupMemberAttribute: member
|
|
attributes:
|
|
type: array
|
|
description: The attribute definitions which form the schema.
|
|
items:
|
|
type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: The name of the attribute.
|
|
example: sAMAccountName
|
|
type:
|
|
type: string
|
|
enum:
|
|
- STRING
|
|
- LONG
|
|
- INT
|
|
- BOOLEAN
|
|
description: The underlying type of the value which an AttributeDefinition represents.
|
|
example: STRING
|
|
schema:
|
|
description: A reference to the schema on the source to the attribute values map to.
|
|
type: object
|
|
properties:
|
|
type:
|
|
description: The type of object being referenced
|
|
type: string
|
|
enum:
|
|
- CONNECTOR_SCHEMA
|
|
example: CONNECTOR_SCHEMA
|
|
id:
|
|
type: string
|
|
description: The object ID this reference applies to.
|
|
example: 2c91808568c529c60168cca6f90c1313
|
|
name:
|
|
type: string
|
|
description: The human-readable display name of the object.
|
|
example: group
|
|
description:
|
|
type: string
|
|
description: A human-readable description of the attribute.
|
|
example: SAM Account Name
|
|
isMulti:
|
|
type: boolean
|
|
description: Flag indicating whether or not the attribute is multi-valued.
|
|
example: false
|
|
default: false
|
|
isEntitlement:
|
|
type: boolean
|
|
description: Flag indicating whether or not the attribute is an entitlement.
|
|
example: false
|
|
default: false
|
|
isGroup:
|
|
type: boolean
|
|
description: |
|
|
Flag indicating whether or not the attribute represents a group.
|
|
This can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute..
|
|
example: false
|
|
default: false
|
|
example:
|
|
- name: sAMAccountName
|
|
type: STRING
|
|
isMultiValued: false
|
|
isEntitlement: false
|
|
isGroup: false
|
|
- name: memberOf
|
|
type: STRING
|
|
schema:
|
|
type: CONNECTOR_SCHEMA
|
|
id: 2c9180887671ff8c01767b4671fc7d60
|
|
name: group
|
|
description: Group membership
|
|
isMultiValued: true
|
|
isEntitlement: true
|
|
isGroup: true
|
|
created:
|
|
type: string
|
|
description: The date the Schema was created.
|
|
format: date-time
|
|
example: '2019-12-24T22:32:58.104Z'
|
|
modified:
|
|
type: string
|
|
description: The date the Schema was last modified.
|
|
format: date-time
|
|
example: '2019-12-31T20:22:28.104Z'
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID.
|
|
$IncludeTypes = "group" # String | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional)
|
|
$IncludeNames = "account" # String | A comma-separated list of schema names to filter result. (optional)
|
|
|
|
# List Schemas on Source
|
|
|
|
try {
|
|
Get-SourceSchemas-SourceId $SourceId
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-SourceSchemas -SourceId $SourceId -IncludeTypes $IncludeTypes -IncludeNames $IncludeNames
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SourceSchemas"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
post:
|
|
operationId: createSourceSchema
|
|
security:
|
|
- userAuth:
|
|
- idn:source-schema:create
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- SOURCE_ADMIN
|
|
tags:
|
|
- Sources
|
|
summary: Create Schema on Source
|
|
description: |
|
|
Use this API to create a new schema on the specified source in Identity Security Cloud (ISC).
|
|
parameters:
|
|
- in: path
|
|
name: sourceId
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listSources
|
|
schema:
|
|
type: string
|
|
description: Source ID.
|
|
example: 2c9180835d191a86015d28455b4a2329
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1sources~1%7BsourceId%7D~1schemas/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/Schema.yaml
|
|
responses:
|
|
'201':
|
|
description: The schema was successfully created on the specified source.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1sources~1%7BsourceId%7D~1schemas/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/Schema.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID.
|
|
$Schema = @"
|
|
{
|
|
"features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ],
|
|
"nativeObjectType" : "User",
|
|
"configuration" : {
|
|
"groupMemberAttribute" : "member"
|
|
},
|
|
"created" : "2019-12-24T22:32:58.104Z",
|
|
"includePermissions" : false,
|
|
"name" : "account",
|
|
"hierarchyAttribute" : "memberOf",
|
|
"modified" : "2019-12-31T20:22:28.104Z",
|
|
"attributes" : [ {
|
|
"name" : "sAMAccountName",
|
|
"type" : "STRING",
|
|
"isMultiValued" : false,
|
|
"isEntitlement" : false,
|
|
"isGroup" : false
|
|
}, {
|
|
"name" : "memberOf",
|
|
"type" : "STRING",
|
|
"schema" : {
|
|
"type" : "CONNECTOR_SCHEMA",
|
|
"id" : "2c9180887671ff8c01767b4671fc7d60",
|
|
"name" : "group"
|
|
},
|
|
"description" : "Group membership",
|
|
"isMultiValued" : true,
|
|
"isEntitlement" : true,
|
|
"isGroup" : true
|
|
} ],
|
|
"id" : "2c9180835d191a86015d28455b4a2329",
|
|
"displayAttribute" : "distinguishedName",
|
|
"identityAttribute" : "sAMAccountName"
|
|
}
|
|
"@
|
|
|
|
# Create Schema on Source
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToSchema -Json $Schema
|
|
New-SourceSchema-SourceId $SourceId -Schema $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# New-SourceSchema -SourceId $SourceId -Schema $Schema
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SourceSchema"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/sources/{sourceId}/schemas/{schemaId}:
|
|
get:
|
|
operationId: getSourceSchema
|
|
tags:
|
|
- Sources
|
|
summary: Get Source Schema by ID
|
|
description: |
|
|
Get the Source Schema by ID in IdentityNow.
|
|
parameters:
|
|
- in: path
|
|
name: sourceId
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listSources
|
|
schema:
|
|
type: string
|
|
description: The Source id.
|
|
example: 2c9180835d191a86015d28455b4a2329
|
|
- in: path
|
|
name: schemaId
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getSourceSchemas
|
|
description: The Schema id.
|
|
example: 2c9180835d191a86015d28455b4a2329
|
|
responses:
|
|
'200':
|
|
description: The requested Schema was successfully retrieved.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1sources~1%7BsourceId%7D~1schemas/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/Schema.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id.
|
|
$SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id.
|
|
|
|
# Get Source Schema by ID
|
|
|
|
try {
|
|
Get-SourceSchema-SourceId $SourceId -SchemaId $SchemaId
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-SourceSchema -SourceId $SourceId -SchemaId $SchemaId
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SourceSchema"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
put:
|
|
operationId: putSourceSchema
|
|
tags:
|
|
- Sources
|
|
summary: Update Source Schema (Full)
|
|
description: |
|
|
This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below.
|
|
|
|
* id
|
|
* name
|
|
* created
|
|
* modified
|
|
|
|
Any attempt to modify these fields will result in an error response with a status code of 400.
|
|
|
|
> `id` must remain in the request body, but it cannot be changed. If `id` is omitted from the request body, the result will be a 400 error.
|
|
parameters:
|
|
- in: path
|
|
name: sourceId
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listSources
|
|
schema:
|
|
type: string
|
|
description: The Source id.
|
|
example: 2c9180835d191a86015d28455b4a2329
|
|
- in: path
|
|
name: schemaId
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getSourceSchemas
|
|
description: The Schema id.
|
|
example: 2c9180835d191a86015d28455b4a2329
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1sources~1%7BsourceId%7D~1schemas/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/Schema.yaml
|
|
responses:
|
|
'200':
|
|
description: The Schema was successfully replaced.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1sources~1%7BsourceId%7D~1schemas/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/Schema.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id.
|
|
$SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id.
|
|
$Schema = @"
|
|
{
|
|
"features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ],
|
|
"nativeObjectType" : "User",
|
|
"configuration" : {
|
|
"groupMemberAttribute" : "member"
|
|
},
|
|
"created" : "2019-12-24T22:32:58.104Z",
|
|
"includePermissions" : false,
|
|
"name" : "account",
|
|
"hierarchyAttribute" : "memberOf",
|
|
"modified" : "2019-12-31T20:22:28.104Z",
|
|
"attributes" : [ {
|
|
"name" : "sAMAccountName",
|
|
"type" : "STRING",
|
|
"isMultiValued" : false,
|
|
"isEntitlement" : false,
|
|
"isGroup" : false
|
|
}, {
|
|
"name" : "memberOf",
|
|
"type" : "STRING",
|
|
"schema" : {
|
|
"type" : "CONNECTOR_SCHEMA",
|
|
"id" : "2c9180887671ff8c01767b4671fc7d60",
|
|
"name" : "group"
|
|
},
|
|
"description" : "Group membership",
|
|
"isMultiValued" : true,
|
|
"isEntitlement" : true,
|
|
"isGroup" : true
|
|
} ],
|
|
"id" : "2c9180835d191a86015d28455b4a2329",
|
|
"displayAttribute" : "distinguishedName",
|
|
"identityAttribute" : "sAMAccountName"
|
|
}
|
|
"@
|
|
|
|
# Update Source Schema (Full)
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToSchema -Json $Schema
|
|
Send-SourceSchema-SourceId $SourceId -SchemaId $SchemaId -Schema $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Send-SourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Schema
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SourceSchema"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
patch:
|
|
operationId: updateSourceSchema
|
|
tags:
|
|
- Sources
|
|
summary: Update Source Schema (Partial)
|
|
description: |
|
|
Use this API to selectively update an existing Schema using a JSONPatch payload.
|
|
|
|
The following schema fields are immutable and cannot be updated:
|
|
|
|
- id
|
|
- name
|
|
- created
|
|
- modified
|
|
|
|
|
|
To switch an account attribute to a group entitlement, you need to have the following in place:
|
|
|
|
- `isEntitlement: true`
|
|
- Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group:
|
|
```json
|
|
{
|
|
"name": "groups",
|
|
"type": "STRING",
|
|
"schema": {
|
|
"type": "CONNECTOR_SCHEMA",
|
|
"id": "2c9180887671ff8c01767b4671fc7d60",
|
|
"name": "group"
|
|
},
|
|
"description": "The groups, roles etc. that reference account group objects",
|
|
"isMulti": true,
|
|
"isEntitlement": true,
|
|
"isGroup": true
|
|
}
|
|
```
|
|
parameters:
|
|
- in: path
|
|
name: sourceId
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listSources
|
|
schema:
|
|
type: string
|
|
description: The Source id.
|
|
example: 2c9180835d191a86015d28455b4a2329
|
|
- in: path
|
|
name: schemaId
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getSourceSchemas
|
|
description: The Schema id.
|
|
example: 2c9180835d191a86015d28455b4a2329
|
|
requestBody:
|
|
required: true
|
|
description: The JSONPatch payload used to update the schema.
|
|
content:
|
|
application/json-patch+json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/JsonPatchOperation.yaml
|
|
examples:
|
|
add-attribute:
|
|
summary: Add an attribute to the end of the list
|
|
value:
|
|
- op: add
|
|
path: /attributes/-
|
|
value:
|
|
name: location
|
|
type: STRING
|
|
schema: null
|
|
description: Employee location
|
|
isMulti: false
|
|
isEntitlement: false
|
|
isGroup: false
|
|
responses:
|
|
'200':
|
|
description: The Schema was successfully updated.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1sources~1%7BsourceId%7D~1schemas/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/Schema.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id.
|
|
$SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id.
|
|
# JsonPatchOperation[] | The JSONPatch payload used to update the schema.
|
|
$JsonPatchOperation = @"{
|
|
"op" : "replace",
|
|
"path" : "/description",
|
|
"value" : "New description"
|
|
}"@
|
|
|
|
|
|
# Update Source Schema (Partial)
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
|
|
Update-SourceSchema-SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Update-SourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $JsonPatchOperation
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SourceSchema"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
delete:
|
|
operationId: deleteSourceSchema
|
|
tags:
|
|
- Sources
|
|
summary: Delete Source Schema by ID
|
|
parameters:
|
|
- in: path
|
|
name: sourceId
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listSources
|
|
schema:
|
|
type: string
|
|
description: The Source id.
|
|
example: 2c9180835d191a86015d28455b4a2329
|
|
- in: path
|
|
name: schemaId
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: getSourceSchemas
|
|
description: The Schema id.
|
|
example: 2c9180835d191a86015d28455b4a2329
|
|
responses:
|
|
'204':
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/204.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id.
|
|
$SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id.
|
|
|
|
# Delete Source Schema by ID
|
|
|
|
try {
|
|
Remove-SourceSchema-SourceId $SourceId -SchemaId $SchemaId
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Remove-SourceSchema -SourceId $SourceId -SchemaId $SchemaId
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SourceSchema"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/sources/{sourceId}/source-health:
|
|
get:
|
|
operationId: getSourceHealth
|
|
security:
|
|
- userAuth:
|
|
- idn:sources:read
|
|
tags:
|
|
- Sources
|
|
summary: Fetches source health by id
|
|
description: This endpoint fetches source health by source's id
|
|
parameters:
|
|
- in: path
|
|
name: sourceId
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listSources
|
|
schema:
|
|
type: string
|
|
description: The Source id.
|
|
example: 2c9180835d191a86015d28455b4a2329
|
|
responses:
|
|
'200':
|
|
description: Fetched source health successfully
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
description: Dto for source health data
|
|
properties:
|
|
id:
|
|
type: string
|
|
readOnly: true
|
|
description: the id of the Source
|
|
example: 2c91808568c529c60168cca6f90c1324
|
|
type:
|
|
type: string
|
|
description: 'Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. '
|
|
example: OpenLDAP - Direct
|
|
name:
|
|
type: string
|
|
description: the name of the source
|
|
example: Source1234
|
|
org:
|
|
type: string
|
|
description: source's org
|
|
example: denali-cjh
|
|
isAuthoritative:
|
|
type: boolean
|
|
example: false
|
|
description: Is the source authoritative
|
|
isCluster:
|
|
type: boolean
|
|
example: false
|
|
description: Is the source in a cluster
|
|
hostname:
|
|
type: string
|
|
example: megapod-useast1-secret-hostname.sailpoint.com
|
|
description: source's hostname
|
|
pod:
|
|
type: string
|
|
description: source's pod
|
|
example: megapod-useast1
|
|
iqServiceVersion:
|
|
type: string
|
|
description: The version of the iqService
|
|
example: iqVersion123
|
|
status:
|
|
type: string
|
|
enum:
|
|
- SOURCE_STATE_ERROR_CLUSTER
|
|
- SOURCE_STATE_ERROR_SOURCE
|
|
- SOURCE_STATE_ERROR_VA
|
|
- SOURCE_STATE_FAILURE_CLUSTER
|
|
- SOURCE_STATE_FAILURE_SOURCE
|
|
- SOURCE_STATE_HEALTHY
|
|
- SOURCE_STATE_UNCHECKED_CLUSTER
|
|
- SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES
|
|
- SOURCE_STATE_UNCHECKED_SOURCE
|
|
- SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS
|
|
description: connection test result
|
|
example: SOURCE_STATE_UNCHECKED_SOURCE
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id.
|
|
|
|
# Fetches source health by id
|
|
|
|
try {
|
|
Get-SourceHealth-SourceId $SourceId
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-SourceHealth -SourceId $SourceId
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SourceHealth"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/sources/{id}/schemas/accounts:
|
|
get:
|
|
tags:
|
|
- Sources
|
|
summary: Downloads source accounts schema template
|
|
description: |-
|
|
This API downloads the CSV schema that defines the account attributes on a source.
|
|
>**NOTE: This API is designated only for Delimited File sources.**
|
|
operationId: getAccountsSchema
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listSources
|
|
schema:
|
|
type: string
|
|
description: The Source id
|
|
example: 8c190e6787aa4ed9a90bd9d5344523fb
|
|
responses:
|
|
'200':
|
|
description: Successfully downloaded the file
|
|
content:
|
|
text/csv:
|
|
example: id,name,givenName,familyName,e-mail,location,manager,groups,startDate,endDate
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:source-schema:read
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id
|
|
|
|
# Downloads source accounts schema template
|
|
|
|
try {
|
|
Get-AccountsSchema-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-AccountsSchema -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccountsSchema"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
post:
|
|
tags:
|
|
- Sources
|
|
summary: Uploads source accounts schema template
|
|
description: |-
|
|
This API uploads a source schema template file to configure a source's account attributes.
|
|
|
|
To retrieve the file to modify and upload, log into Identity Now.
|
|
|
|
Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema**
|
|
|
|
>**NOTE: This API is designated only for Delimited File sources.**
|
|
operationId: importAccountsSchema
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listSources
|
|
schema:
|
|
type: string
|
|
description: The Source id
|
|
example: 8c190e6787aa4ed9a90bd9d5344523fb
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
multipart/form-data:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
file:
|
|
type: string
|
|
format: binary
|
|
responses:
|
|
'200':
|
|
description: Successfully uploaded the file
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1sources~1%7BsourceId%7D~1schemas/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/Schema.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:source-schema:manage
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id
|
|
$File = # System.IO.FileInfo | (optional)
|
|
|
|
# Uploads source accounts schema template
|
|
|
|
try {
|
|
Import-AccountsSchema-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Import-AccountsSchema -Id $Id -File $File
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-AccountsSchema"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/sources/{id}/schemas/entitlements:
|
|
get:
|
|
tags:
|
|
- Sources
|
|
summary: Downloads source entitlements schema template
|
|
description: |-
|
|
This API downloads the CSV schema that defines the entitlement attributes on a source.
|
|
|
|
>**NOTE: This API is designated only for Delimited File sources.**
|
|
operationId: getEntitlementsSchema
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listSources
|
|
schema:
|
|
type: string
|
|
description: The Source id
|
|
example: 8c190e6787aa4ed9a90bd9d5344523fb
|
|
- in: query
|
|
name: schemaName
|
|
schema:
|
|
type: string
|
|
description: Name of entitlement schema
|
|
example: '?schemaName=group'
|
|
responses:
|
|
'200':
|
|
description: Successfully downloaded the file
|
|
content:
|
|
text/csv:
|
|
example: id,name,displayName,created,description,modified,entitlements,groups,permissions
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:source-schema:read
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id
|
|
$SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional)
|
|
|
|
# Downloads source entitlements schema template
|
|
|
|
try {
|
|
Get-EntitlementsSchema-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-EntitlementsSchema -Id $Id -SchemaName $SchemaName
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-EntitlementsSchema"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
post:
|
|
tags:
|
|
- Sources
|
|
summary: Uploads source entitlements schema template
|
|
description: |-
|
|
This API uploads a source schema template file to configure a source's entitlement attributes.
|
|
|
|
To retrieve the file to modify and upload, log into Identity Now.
|
|
|
|
Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Import Entitlements** -> **Download**
|
|
|
|
>**NOTE: This API is designated only for Delimited File sources.**
|
|
operationId: importEntitlementsSchema
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listSources
|
|
schema:
|
|
type: string
|
|
description: The Source id
|
|
example: 8c190e6787aa4ed9a90bd9d5344523fb
|
|
- in: query
|
|
name: schemaName
|
|
schema:
|
|
type: string
|
|
description: Name of entitlement schema
|
|
example: '?schemaName=group'
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
multipart/form-data:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
file:
|
|
type: string
|
|
format: binary
|
|
responses:
|
|
'200':
|
|
description: Successfully uploaded the file
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1sources~1%7BsourceId%7D~1schemas/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/Schema.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:source-schema:manage
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id
|
|
$SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional)
|
|
$File = # System.IO.FileInfo | (optional)
|
|
|
|
# Uploads source entitlements schema template
|
|
|
|
try {
|
|
Import-EntitlementsSchema-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Import-EntitlementsSchema -Id $Id -SchemaName $SchemaName -File $File
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-EntitlementsSchema"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/sources/{sourceId}/upload-connector-file:
|
|
post:
|
|
operationId: importConnectorFile
|
|
security:
|
|
- userAuth:
|
|
- idn:sources-admin:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
tags:
|
|
- Sources
|
|
summary: Upload connector file to source
|
|
parameters:
|
|
- in: path
|
|
name: sourceId
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listSources
|
|
schema:
|
|
type: string
|
|
description: The Source id.
|
|
example: 2c9180835d191a86015d28455b4a2329
|
|
description: This uploads a supplemental source connector file (like jdbc driver jars) to a source's S3 bucket. This also sends ETS and Audit events.
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
multipart/form-data:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
file:
|
|
type: string
|
|
format: binary
|
|
responses:
|
|
'200':
|
|
description: Uploaded the file successfully and sent all post-upload events
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1sources/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/Source.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id.
|
|
$File = # System.IO.FileInfo | (optional)
|
|
|
|
# Upload connector file to source
|
|
|
|
try {
|
|
Import-ConnectorFile-SourceId $SourceId
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Import-ConnectorFile -SourceId $SourceId -File $File
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-ConnectorFile"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/sources/{sourceId}/connections:
|
|
get:
|
|
operationId: getSourceConnections
|
|
security:
|
|
- userAuth:
|
|
- idn:sources:read
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- SOURCE_ADMIN
|
|
- SOURCE_SUBADMIN
|
|
tags:
|
|
- Sources
|
|
summary: Get Source Connections by ID
|
|
description: Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC).
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listSources
|
|
description: Source ID.
|
|
example: 2c9180835d191a86015d28455b4a2329
|
|
responses:
|
|
'200':
|
|
description: Source Connections object.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
identityProfiles:
|
|
type: array
|
|
description: The IdentityProfile attached to this source
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: ID of the IdentityProfile this reference applies
|
|
example: 76cfddb62818416f816bc494410f46c4
|
|
name:
|
|
type: string
|
|
description: Human-readable display name of the IdentityProfile to which this reference applies
|
|
example: ODS-Identity-Profile
|
|
identityCount:
|
|
type: integer
|
|
format: int64
|
|
description: The Number of Identities managed by this IdentityProfile
|
|
example: 100
|
|
credentialProfiles:
|
|
type: array
|
|
description: Name of the CredentialProfile attached to this source
|
|
items:
|
|
type: string
|
|
example:
|
|
- Profile ODS
|
|
sourceAttributes:
|
|
type: array
|
|
description: The attributes attached to this source
|
|
items:
|
|
type: string
|
|
example:
|
|
- sAMAccountName
|
|
- mail
|
|
- sn
|
|
- givenName
|
|
- displayName
|
|
- employeeNumber
|
|
- manager
|
|
- telephoneNumber
|
|
mappingProfiles:
|
|
type: array
|
|
description: The profiles attached to this source
|
|
example:
|
|
- ODS-AD-Profile
|
|
- ODS-Profile2
|
|
items:
|
|
type: string
|
|
dependentCustomTransforms:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1transforms/post/requestBody/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/Transform.yaml
|
|
dependentApps:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
cloudAppId:
|
|
type: string
|
|
description: Id of the connected Application
|
|
example: 9e3cdd80edf84f119327df8bbd5bb5ac
|
|
description:
|
|
type: string
|
|
description: Description of the connected Application
|
|
example: This is a Sailpoint application
|
|
enabled:
|
|
type: boolean
|
|
description: Is the Application enabled
|
|
example: true
|
|
default: true
|
|
provisionRequestEnabled:
|
|
type: boolean
|
|
description: Is Provisioning enabled for connected Application
|
|
example: true
|
|
default: true
|
|
accountSource:
|
|
type: object
|
|
description: The Account Source of the connected Application
|
|
properties:
|
|
useForPasswordManagement:
|
|
type: boolean
|
|
description: Use this Account Source for password management
|
|
example: false
|
|
default: false
|
|
passwordPolicies:
|
|
type: array
|
|
description: A list of Password Policies for this Account Source
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: DTO type
|
|
example: PASSWORD_POLICY
|
|
id:
|
|
type: string
|
|
description: ID of the object to which this reference applies
|
|
example: 2c91808568c529c60168cca6f90c1313
|
|
name:
|
|
type: string
|
|
description: Human-readable display name of the object to which this reference applies
|
|
example: Policy ODS
|
|
launcherCount:
|
|
type: integer
|
|
format: int64
|
|
description: The amount of launchers for connected Application (long type)
|
|
example: 100
|
|
matchAllAccount:
|
|
type: boolean
|
|
description: Is Provisioning enabled for connected Application
|
|
example: true
|
|
default: false
|
|
owner:
|
|
type: array
|
|
description: The owner of the connected Application
|
|
items:
|
|
$ref: '#/components/schemas/Account/allOf/1/properties/identity'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/BaseReferenceDto.yaml
|
|
appCenterEnabled:
|
|
type: boolean
|
|
description: Is App Center enabled for connected Application
|
|
example: false
|
|
default: false
|
|
missingDependents:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
dependencyType:
|
|
type: string
|
|
enum:
|
|
- identityProfiles
|
|
- credentialProfiles
|
|
- mappingProfiles
|
|
- sourceAttributes
|
|
- dependantCustomTransforms
|
|
- dependantApps
|
|
description: The type of dependency type that is missing in the SourceConnections
|
|
example: dependantApps
|
|
reason:
|
|
type: string
|
|
description: The reason why this dependency is missing
|
|
example: If there was an error retrieving any dependencies, it would lbe listed here
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID.
|
|
|
|
# Get Source Connections by ID
|
|
|
|
try {
|
|
Get-SourceConnections-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-SourceConnections -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SourceConnections"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/tagged-objects:
|
|
get:
|
|
operationId: listTaggedObjects
|
|
security:
|
|
- userAuth:
|
|
- idn:tag:read
|
|
- idn:tag:manage
|
|
tags:
|
|
- Tagged Objects
|
|
summary: List Tagged Objects
|
|
description: |-
|
|
This API returns a list of all tagged objects.
|
|
|
|
Any authenticated token may be used to call this API.
|
|
parameters:
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
- in: query
|
|
name: filters
|
|
schema:
|
|
type: string
|
|
description: |-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
**objectRef.id**: *eq, in*
|
|
|
|
**objectRef.type**: *eq, in*
|
|
|
|
**tagName**: *eq, in*
|
|
example: tagName eq "BU_FINANCE"
|
|
required: false
|
|
responses:
|
|
'200':
|
|
description: List of all tagged objects.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
description: Tagged object.
|
|
properties:
|
|
objectRef:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
enum:
|
|
- ACCESS_PROFILE
|
|
- APPLICATION
|
|
- CAMPAIGN
|
|
- ENTITLEMENT
|
|
- IDENTITY
|
|
- ROLE
|
|
- SOD_POLICY
|
|
- SOURCE
|
|
example: IDENTITY
|
|
description: DTO type
|
|
id:
|
|
type: string
|
|
description: ID of the object this reference applies to
|
|
example: 2c91808568c529c60168cca6f90c1313
|
|
name:
|
|
type: string
|
|
nullable: true
|
|
description: Human-readable display name of the object this reference applies to
|
|
example: William Wilson
|
|
tags:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Labels to be applied to an Object
|
|
example:
|
|
- BU_FINANCE
|
|
- PCI
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
$Filters = "tagName eq "BU_FINANCE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional)
|
|
|
|
# List Tagged Objects
|
|
|
|
try {
|
|
Get-TaggedObjects
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-TaggedObjects -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-TaggedObjects"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
post:
|
|
operationId: setTagToObject
|
|
security:
|
|
- userAuth:
|
|
- idn:tag:manage
|
|
tags:
|
|
- Tagged Objects
|
|
summary: Add Tag to Object
|
|
description: |-
|
|
This adds a tag to an object.
|
|
|
|
Any authenticated token may be used to call this API.
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1tagged-objects/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/TaggedObject.yaml
|
|
responses:
|
|
'201':
|
|
description: Created.
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$TaggedObject = @"
|
|
{
|
|
"objectRef" : {
|
|
"name" : "William Wilson",
|
|
"id" : "2c91808568c529c60168cca6f90c1313",
|
|
"type" : "IDENTITY"
|
|
},
|
|
"tags" : [ "BU_FINANCE", "PCI" ]
|
|
}
|
|
"@
|
|
|
|
# Add Tag to Object
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject
|
|
Set-TagToObject-TaggedObject $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Set-TagToObject -TaggedObject $TaggedObject
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-TagToObject"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/tagged-objects/{type}:
|
|
get:
|
|
operationId: listTaggedObjectsByType
|
|
security:
|
|
- userAuth:
|
|
- idn:tag:read
|
|
- idn:tag:manage
|
|
tags:
|
|
- Tagged Objects
|
|
summary: List Tagged Objects by Type
|
|
description: |-
|
|
This API returns a list of all tagged objects by type.
|
|
|
|
Any authenticated token may be used to call this API.
|
|
parameters:
|
|
- in: path
|
|
name: type
|
|
schema:
|
|
type: string
|
|
enum:
|
|
- ACCESS_PROFILE
|
|
- APPLICATION
|
|
- CAMPAIGN
|
|
- ENTITLEMENT
|
|
- IDENTITY
|
|
- ROLE
|
|
- SOD_POLICY
|
|
- SOURCE
|
|
required: true
|
|
description: The type of tagged object to retrieve.
|
|
example: ROLE
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
- in: query
|
|
name: filters
|
|
schema:
|
|
type: string
|
|
description: |-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
**objectRef.id**: *eq*
|
|
|
|
**objectRef.type**: *eq*
|
|
example: objectRef.id eq "2c91808568c529c60168cca6f90c1313"
|
|
required: false
|
|
responses:
|
|
'200':
|
|
description: List of all tagged objects for specified type.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1tagged-objects/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/TaggedObject.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve.
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
$Filters = "objectRef.id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional)
|
|
|
|
# List Tagged Objects by Type
|
|
|
|
try {
|
|
Get-TaggedObjectsByType-Type $Type
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-TaggedObjectsByType -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-TaggedObjectsByType"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/tagged-objects/{type}/{id}:
|
|
get:
|
|
operationId: getTaggedObject
|
|
security:
|
|
- userAuth:
|
|
- idn:tag:read
|
|
- idn:tag:manage
|
|
tags:
|
|
- Tagged Objects
|
|
summary: Get Tagged Object
|
|
description: This gets a tagged object for the specified type.
|
|
parameters:
|
|
- in: path
|
|
name: type
|
|
schema:
|
|
type: string
|
|
enum:
|
|
- ACCESS_PROFILE
|
|
- APPLICATION
|
|
- CAMPAIGN
|
|
- ENTITLEMENT
|
|
- IDENTITY
|
|
- ROLE
|
|
- SOD_POLICY
|
|
- SOURCE
|
|
required: true
|
|
description: The type of tagged object to retrieve.
|
|
example: ROLE
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listTaggedObjects
|
|
description: The ID of the object reference to retrieve.
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
responses:
|
|
'200':
|
|
description: Tagged object by type and ID.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1tagged-objects/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/TaggedObject.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve.
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve.
|
|
|
|
# Get Tagged Object
|
|
|
|
try {
|
|
Get-TaggedObject-Type $Type -Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-TaggedObject -Type $Type -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-TaggedObject"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
put:
|
|
operationId: putTaggedObject
|
|
security:
|
|
- userAuth:
|
|
- idn:tag:manage
|
|
tags:
|
|
- Tagged Objects
|
|
summary: Update Tagged Object
|
|
description: This updates a tagged object for the specified type.
|
|
parameters:
|
|
- in: path
|
|
name: type
|
|
schema:
|
|
type: string
|
|
enum:
|
|
- ACCESS_PROFILE
|
|
- APPLICATION
|
|
- CAMPAIGN
|
|
- ENTITLEMENT
|
|
- IDENTITY
|
|
- ROLE
|
|
- SOD_POLICY
|
|
- SOURCE
|
|
required: true
|
|
description: The type of tagged object to update.
|
|
example: ROLE
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listTaggedObjects
|
|
description: The ID of the object reference to update.
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1tagged-objects/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/TaggedObject.yaml
|
|
responses:
|
|
'200':
|
|
description: Tagged object by type and ID.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1tagged-objects/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/TaggedObject.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Type = "ACCESS_PROFILE" # String | The type of tagged object to update.
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to update.
|
|
$TaggedObject = @"
|
|
{
|
|
"objectRef" : {
|
|
"name" : "William Wilson",
|
|
"id" : "2c91808568c529c60168cca6f90c1313",
|
|
"type" : "IDENTITY"
|
|
},
|
|
"tags" : [ "BU_FINANCE", "PCI" ]
|
|
}
|
|
"@
|
|
|
|
# Update Tagged Object
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject
|
|
Send-TaggedObject-Type $Type -Id $Id -TaggedObject $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Send-TaggedObject -Type $Type -Id $Id -TaggedObject $TaggedObject
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-TaggedObject"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
delete:
|
|
operationId: deleteTaggedObject
|
|
security:
|
|
- userAuth:
|
|
- idn:tag:manage
|
|
tags:
|
|
- Tagged Objects
|
|
summary: Delete Object Tags
|
|
description: Delete all tags from a tagged object.
|
|
parameters:
|
|
- in: path
|
|
name: type
|
|
schema:
|
|
type: string
|
|
enum:
|
|
- ACCESS_PROFILE
|
|
- APPLICATION
|
|
- CAMPAIGN
|
|
- ENTITLEMENT
|
|
- IDENTITY
|
|
- ROLE
|
|
- SOD_POLICY
|
|
- SOURCE
|
|
required: true
|
|
description: The type of object to delete tags from.
|
|
example: ROLE
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listTaggedObjects
|
|
description: The ID of the object to delete tags from.
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
responses:
|
|
'204':
|
|
description: No content.
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Type = "ACCESS_PROFILE" # String | The type of object to delete tags from.
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object to delete tags from.
|
|
|
|
# Delete Object Tags
|
|
|
|
try {
|
|
Remove-TaggedObject-Type $Type -Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Remove-TaggedObject -Type $Type -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-TaggedObject"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/tagged-objects/bulk-add:
|
|
post:
|
|
operationId: setTagsToManyObjects
|
|
security:
|
|
- userAuth:
|
|
- idn:tag:manage
|
|
- applicationAuth:
|
|
- idn:tag:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- CERT_ADMIN
|
|
- REPORT_ADMIN
|
|
- ROLE_ADMIN
|
|
- ROLE_SUBADMIN
|
|
- SOURCE_ADMIN
|
|
- SOURCE_SUBADMIN
|
|
tags:
|
|
- Tagged Objects
|
|
summary: Tag Multiple Objects
|
|
description: This API adds tags to multiple objects.
|
|
requestBody:
|
|
required: true
|
|
description: Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
objectRefs:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1tagged-objects/get/responses/200/content/application~1json/schema/items/properties/objectRef'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/TaggedObjectDto.yaml
|
|
tags:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Label to be applied to an Object
|
|
example:
|
|
- BU_FINANCE
|
|
- PCI
|
|
operation:
|
|
type: string
|
|
enum:
|
|
- APPEND
|
|
- MERGE
|
|
default: APPEND
|
|
description: |-
|
|
If APPEND, tags are appended to the list of tags for the object. A 400 error is returned if this would add duplicate tags to the object.
|
|
|
|
If MERGE, tags are merged with the existing tags. Duplicate tags are silently ignored.
|
|
example: MERGE
|
|
responses:
|
|
'200':
|
|
description: Request succeeded.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
objectRefs:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1tagged-objects/get/responses/200/content/application~1json/schema/items/properties/objectRef'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/TaggedObjectDto.yaml
|
|
tags:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Label to be applied to an Object
|
|
example:
|
|
- BU_FINANCE
|
|
- PCI
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$BulkAddTaggedObject = @"
|
|
{
|
|
"objectRefs" : [ {
|
|
"name" : "William Wilson",
|
|
"id" : "2c91808568c529c60168cca6f90c1313",
|
|
"type" : "IDENTITY"
|
|
}, {
|
|
"name" : "William Wilson",
|
|
"id" : "2c91808568c529c60168cca6f90c1313",
|
|
"type" : "IDENTITY"
|
|
} ],
|
|
"operation" : "MERGE",
|
|
"tags" : [ "BU_FINANCE", "PCI" ]
|
|
}
|
|
"@
|
|
|
|
# Tag Multiple Objects
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToBulkAddTaggedObject -Json $BulkAddTaggedObject
|
|
Set-TagsToManyObjects-BulkAddTaggedObject $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Set-TagsToManyObjects -BulkAddTaggedObject $BulkAddTaggedObject
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-TagsToManyObjects"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/tagged-objects/bulk-remove:
|
|
post:
|
|
operationId: deleteTagsToManyObject
|
|
security:
|
|
- userAuth:
|
|
- idn:tag:manage
|
|
- applicationAuth:
|
|
- idn:tag:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
- CERT_ADMIN
|
|
- REPORT_ADMIN
|
|
- ROLE_ADMIN
|
|
- ROLE_SUBADMIN
|
|
- SOURCE_ADMIN
|
|
- SOURCE_SUBADMIN
|
|
tags:
|
|
- Tagged Objects
|
|
summary: Remove Tags from Multiple Objects
|
|
description: This API removes tags from multiple objects.
|
|
requestBody:
|
|
description: Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE.
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
objectRefs:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1tagged-objects/get/responses/200/content/application~1json/schema/items/properties/objectRef'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/TaggedObjectDto.yaml
|
|
tags:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Label to be applied to an Object
|
|
example:
|
|
- BU_FINANCE
|
|
- PCI
|
|
responses:
|
|
'204':
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/204.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$BulkRemoveTaggedObject = @"
|
|
{
|
|
"objectRefs" : [ {
|
|
"name" : "William Wilson",
|
|
"id" : "2c91808568c529c60168cca6f90c1313",
|
|
"type" : "IDENTITY"
|
|
}, {
|
|
"name" : "William Wilson",
|
|
"id" : "2c91808568c529c60168cca6f90c1313",
|
|
"type" : "IDENTITY"
|
|
} ],
|
|
"tags" : [ "BU_FINANCE", "PCI" ]
|
|
}
|
|
"@
|
|
|
|
# Remove Tags from Multiple Objects
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToBulkRemoveTaggedObject -Json $BulkRemoveTaggedObject
|
|
Remove-TagsToManyObject-BulkRemoveTaggedObject $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Remove-TagsToManyObject -BulkRemoveTaggedObject $BulkRemoveTaggedObject
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-TagsToManyObject"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/transforms:
|
|
get:
|
|
tags:
|
|
- Transforms
|
|
summary: List transforms
|
|
description: Gets a list of all saved transform objects.
|
|
operationId: listTransforms
|
|
parameters:
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
- name: name
|
|
in: query
|
|
description: Name of the transform to retrieve from the list.
|
|
required: false
|
|
style: form
|
|
schema:
|
|
type: string
|
|
example: ExampleTransformName123
|
|
- name: filters
|
|
in: query
|
|
description: |-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
**internal**: *eq*
|
|
|
|
**name**: *eq, sw*
|
|
required: false
|
|
style: form
|
|
explode: true
|
|
example: name eq "Uppercase"
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: A list of transforms matching the given criteria.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
allOf:
|
|
- $ref: '#/paths/~1transforms/post/requestBody/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/Transform.yaml
|
|
- type: object
|
|
required:
|
|
- id
|
|
- internal
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: Unique ID of this transform
|
|
example: 2cd78adghjkja34jh2b1hkjhasuecd
|
|
internal:
|
|
type: boolean
|
|
description: Indicates whether this is an internal SailPoint-created transform or a customer-created transform
|
|
example: false
|
|
default: false
|
|
example:
|
|
- id: 2cd78adghjkja34jh2b1hkjhasuecd
|
|
name: Timestamp To Date
|
|
type: dateFormat
|
|
attributes:
|
|
inputFormat: MMM-dd-yyyy, HH:mm:ss.SSS
|
|
outputFormat: yyyy/dd/MM
|
|
internal: false
|
|
- id: 2lkas8dhj4bkuakja77giih7l4ashh
|
|
name: PrefixSubstring
|
|
type: substring
|
|
attributes:
|
|
begin: 0
|
|
end: 3
|
|
internal: true
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:transform:read
|
|
- idn:transform:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
$Name = "ExampleTransformName123" # String | Name of the transform to retrieve from the list. (optional)
|
|
$Filters = "name eq "Uppercase"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* (optional)
|
|
|
|
# List transforms
|
|
|
|
try {
|
|
Get-Transforms
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-Transforms -Offset $Offset -Limit $Limit -Count $Count -Name $Name -Filters $Filters
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Transforms"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
post:
|
|
tags:
|
|
- Transforms
|
|
summary: Create transform
|
|
description: Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI.
|
|
operationId: createTransform
|
|
requestBody:
|
|
required: true
|
|
description: The transform to be created.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
description: The representation of an internally- or customer-defined transform.
|
|
required:
|
|
- name
|
|
- type
|
|
- attributes
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Unique name of this transform
|
|
example: Timestamp To Date
|
|
minLength: 1
|
|
maxLength: 50
|
|
type:
|
|
type: string
|
|
description: The type of transform operation
|
|
enum:
|
|
- accountAttribute
|
|
- base64Decode
|
|
- base64Encode
|
|
- concat
|
|
- conditional
|
|
- dateCompare
|
|
- dateFormat
|
|
- dateMath
|
|
- decomposeDiacriticalMarks
|
|
- e164phone
|
|
- firstValid
|
|
- rule
|
|
- identityAttribute
|
|
- indexOf
|
|
- iso3166
|
|
- lastIndexOf
|
|
- leftPad
|
|
- lookup
|
|
- lower
|
|
- normalizeNames
|
|
- randomAlphaNumeric
|
|
- randomNumeric
|
|
- reference
|
|
- replaceAll
|
|
- replace
|
|
- rightPad
|
|
- split
|
|
- static
|
|
- substring
|
|
- trim
|
|
- upper
|
|
- usernameGenerator
|
|
- uuid
|
|
- displayName
|
|
- rfc5646
|
|
example: dateFormat
|
|
externalDocs:
|
|
description: Transform Operations
|
|
url: https://developer.sailpoint.com/idn/docs/transforms/operations
|
|
attributes:
|
|
nullable: true
|
|
description: Meta-data about the transform. Values in this list are specific to the type of transform to be executed.
|
|
oneOf:
|
|
- $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/AccountAttribute.yaml
|
|
- $ref: '#/components/schemas/Transform/properties/attributes/oneOf/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/Base64Decode.yaml
|
|
- $ref: '#/components/schemas/Transform/properties/attributes/oneOf/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/Base64Encode.yaml
|
|
- $ref: '#/components/schemas/Transform/properties/attributes/oneOf/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/Concatenation.yaml
|
|
- $ref: '#/components/schemas/Transform/properties/attributes/oneOf/4'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/Conditional.yaml
|
|
- $ref: '#/components/schemas/Transform/properties/attributes/oneOf/5'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/DateCompare.yaml
|
|
- $ref: '#/components/schemas/Transform/properties/attributes/oneOf/6'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/DateFormat.yaml
|
|
- $ref: '#/components/schemas/Transform/properties/attributes/oneOf/7'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/DateMath.yaml
|
|
- $ref: '#/components/schemas/Transform/properties/attributes/oneOf/8'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/DecomposeDiacriticalMarks.yaml
|
|
- $ref: '#/components/schemas/Transform/properties/attributes/oneOf/9'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/E164phone.yaml
|
|
- $ref: '#/components/schemas/Transform/properties/attributes/oneOf/10'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/FirstValid.yaml
|
|
- $ref: '#/components/schemas/Transform/properties/attributes/oneOf/11'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/Rule.yaml
|
|
- $ref: '#/components/schemas/Transform/properties/attributes/oneOf/12'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/IdentityAttribute.yaml
|
|
- $ref: '#/components/schemas/Transform/properties/attributes/oneOf/13'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/IndexOf.yaml
|
|
- $ref: '#/components/schemas/Transform/properties/attributes/oneOf/14'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/ISO3166.yaml
|
|
- $ref: '#/components/schemas/Transform/properties/attributes/oneOf/15'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/LeftPad.yaml
|
|
- $ref: '#/components/schemas/Transform/properties/attributes/oneOf/16'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/Lookup.yaml
|
|
- $ref: '#/components/schemas/Transform/properties/attributes/oneOf/17'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/Lower.yaml
|
|
- $ref: '#/components/schemas/Transform/properties/attributes/oneOf/18'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/NameNormalizer.yaml
|
|
- $ref: '#/components/schemas/Transform/properties/attributes/oneOf/19'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/RandomAlphaNumeric.yaml
|
|
- $ref: '#/components/schemas/Transform/properties/attributes/oneOf/20'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/RandomNumeric.yaml
|
|
- $ref: '#/components/schemas/Transform/properties/attributes/oneOf/21'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/Reference.yaml
|
|
- $ref: '#/components/schemas/Transform/properties/attributes/oneOf/22'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/ReplaceAll.yaml
|
|
- $ref: '#/components/schemas/Transform/properties/attributes/oneOf/23'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/Replace.yaml
|
|
- $ref: '#/components/schemas/Transform/properties/attributes/oneOf/24'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/RightPad.yaml
|
|
- $ref: '#/components/schemas/Transform/properties/attributes/oneOf/25'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/Split.yaml
|
|
- $ref: '#/components/schemas/Transform/properties/attributes/oneOf/26'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/Static.yaml
|
|
- $ref: '#/components/schemas/Transform/properties/attributes/oneOf/27'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/Substring.yaml
|
|
- $ref: '#/components/schemas/Transform/properties/attributes/oneOf/28'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/Trim.yaml
|
|
- $ref: '#/components/schemas/Transform/properties/attributes/oneOf/29'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/Upper.yaml
|
|
- $ref: '#/components/schemas/Transform/properties/attributes/oneOf/30'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/UUIDGenerator.yaml
|
|
example:
|
|
name: Timestamp To Date
|
|
type: dateFormat
|
|
attributes:
|
|
inputFormat: MMM dd yyyy, HH:mm:ss.SSS
|
|
outputFormat: yyyy/dd/MM
|
|
responses:
|
|
'201':
|
|
description: Indicates the transform was successfully created and returns its representation.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1transforms/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/TransformRead.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:transform:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Transform = @"
|
|
{
|
|
"name" : "Timestamp To Date",
|
|
"attributes" : {
|
|
"input" : {
|
|
"type" : "accountAttribute",
|
|
"attributes" : {
|
|
"attributeName" : "first_name",
|
|
"sourceName" : "Source"
|
|
}
|
|
},
|
|
"accountSortAttribute" : "created",
|
|
"accountReturnFirstLink" : false,
|
|
"requiresPeriodicRefresh" : false,
|
|
"accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')",
|
|
"attributeName" : "DEPARTMENT",
|
|
"accountSortDescending" : false,
|
|
"sourceName" : "Workday",
|
|
"accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))"
|
|
},
|
|
"type" : "dateFormat"
|
|
}
|
|
"@
|
|
|
|
# Create transform
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToTransform -Json $Transform
|
|
New-Transform-Transform $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# New-Transform -Transform $Transform
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Transform"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/transforms/{id}:
|
|
get:
|
|
tags:
|
|
- Transforms
|
|
summary: Transform by ID
|
|
description: This API returns the transform specified by the given ID.
|
|
operationId: getTransform
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: ID of the transform to retrieve
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listTransforms
|
|
style: simple
|
|
explode: false
|
|
example: 2cd78adghjkja34jh2b1hkjhasuecd
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: Transform with the given ID
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1transforms/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/TransformRead.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:transform:read
|
|
- idn:transform:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to retrieve
|
|
|
|
# Transform by ID
|
|
|
|
try {
|
|
Get-Transform-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-Transform -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Transform"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
put:
|
|
tags:
|
|
- Transforms
|
|
summary: Update a transform
|
|
description: Replaces the transform specified by the given ID with the transform provided in the request body. Only the "attributes" field is mutable. Attempting to change other properties (ex. "name" and "type") will result in an error.
|
|
operationId: updateTransform
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: ID of the transform to update
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listTransforms
|
|
style: simple
|
|
explode: false
|
|
schema:
|
|
type: string
|
|
example: 2cd78adghjkja34jh2b1hkjhasuecd
|
|
requestBody:
|
|
description: The updated transform object. Must include "name", "type", and "attributes" fields, but "name" and "type" must not be modified.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1transforms/post/requestBody/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/Transform.yaml
|
|
example:
|
|
name: Timestamp To Date
|
|
type: dateFormat
|
|
attributes:
|
|
inputFormat: MMM-dd-yyyy, HH:mm:ss.SSS
|
|
outputFormat: yyyy/dd/MM
|
|
responses:
|
|
'200':
|
|
description: Indicates the transform was successfully updated and returns its new representation.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1transforms/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/TransformRead.yaml
|
|
example:
|
|
id: 2cd78adghjkja34jh2b1hkjhasuecd
|
|
name: Timestamp To Date
|
|
type: dateFormat
|
|
attributes:
|
|
inputFormat: MMM-dd-yyyy, HH:mm:ss.SSS
|
|
outputFormat: yyyy/dd/MM
|
|
internal: false
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:transform:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to update
|
|
$Transform = @"
|
|
{
|
|
"name" : "Timestamp To Date",
|
|
"attributes" : {
|
|
"input" : {
|
|
"type" : "accountAttribute",
|
|
"attributes" : {
|
|
"attributeName" : "first_name",
|
|
"sourceName" : "Source"
|
|
}
|
|
},
|
|
"accountSortAttribute" : "created",
|
|
"accountReturnFirstLink" : false,
|
|
"requiresPeriodicRefresh" : false,
|
|
"accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')",
|
|
"attributeName" : "DEPARTMENT",
|
|
"accountSortDescending" : false,
|
|
"sourceName" : "Workday",
|
|
"accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))"
|
|
},
|
|
"type" : "dateFormat"
|
|
}
|
|
"@
|
|
|
|
# Update a transform
|
|
|
|
try {
|
|
Update-Transform-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Update-Transform -Id $Id -Transform $Transform
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Transform"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
delete:
|
|
tags:
|
|
- Transforms
|
|
summary: Delete a transform
|
|
description: Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform.
|
|
operationId: deleteTransform
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: ID of the transform to delete
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listTransforms
|
|
style: simple
|
|
explode: false
|
|
schema:
|
|
type: string
|
|
example: 2cd78adghjkja34jh2b1hkjhasuecd
|
|
responses:
|
|
'204':
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/204.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
security:
|
|
- userAuth:
|
|
- idn:transform:manage
|
|
x-sailpoint-userLevels:
|
|
- ORG_ADMIN
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to delete
|
|
|
|
# Delete a transform
|
|
|
|
try {
|
|
Remove-Transform-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Remove-Transform -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Transform"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/work-items:
|
|
get:
|
|
operationId: listWorkItems
|
|
tags:
|
|
- Work Items
|
|
summary: List Work Items
|
|
description: This gets a collection of work items belonging to either the specified user(admin required), or the current user.
|
|
parameters:
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
- in: query
|
|
name: ownerId
|
|
schema:
|
|
type: string
|
|
description: ID of the work item owner.
|
|
required: false
|
|
example: 1211bcaa32112bcef6122adb21cef1ac
|
|
responses:
|
|
'200':
|
|
description: List of work items
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: ID of the work item
|
|
example: 2c9180835d2e5168015d32f890ca1581
|
|
requesterId:
|
|
type: string
|
|
description: ID of the requester
|
|
example: 2c9180835d2e5168015d32f890ca1581
|
|
nullable: true
|
|
requesterDisplayName:
|
|
type: string
|
|
description: The displayname of the requester
|
|
example: John Smith
|
|
nullable: true
|
|
ownerId:
|
|
type: string
|
|
description: The ID of the owner
|
|
example: 2c9180835d2e5168015d32f890ca1581
|
|
nullable: true
|
|
ownerName:
|
|
type: string
|
|
description: The name of the owner
|
|
example: Jason Smith
|
|
created:
|
|
type: string
|
|
format: date-time
|
|
example: '2017-07-11T18:45:37.098Z'
|
|
description: Time when the work item was created
|
|
modified:
|
|
type: string
|
|
format: date-time
|
|
example: '2018-06-25T20:22:28.104Z'
|
|
description: Time when the work item was last updated
|
|
nullable: true
|
|
description:
|
|
type: string
|
|
description: The description of the work item
|
|
example: Create account on source 'AD'
|
|
state:
|
|
$ref: '#/components/schemas/WorkItems/properties/state'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/WorkItemStateManualWorkItems.yaml
|
|
type:
|
|
$ref: '#/components/schemas/WorkItems/properties/type'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/WorkItemTypeManualWorkItems.yaml
|
|
remediationItems:
|
|
type: array
|
|
nullable: true
|
|
items:
|
|
$ref: '#/components/schemas/WorkItems/properties/remediationItems/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/RemediationItemDetails.yaml
|
|
description: A list of remediation items
|
|
approvalItems:
|
|
type: array
|
|
nullable: true
|
|
items:
|
|
$ref: '#/components/schemas/WorkItems/properties/approvalItems/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ApprovalItemDetails.yaml
|
|
description: A list of items that need to be approved
|
|
name:
|
|
type: string
|
|
description: The work item name
|
|
example: Account Create
|
|
nullable: true
|
|
completed:
|
|
type: string
|
|
format: date-time
|
|
example: '2018-10-19T13:49:37.385Z'
|
|
description: The time at which the work item completed
|
|
nullable: true
|
|
numItems:
|
|
type: integer
|
|
format: int32
|
|
description: The number of items in the work item
|
|
example: 19
|
|
nullable: true
|
|
form:
|
|
allOf:
|
|
- $ref: '#/components/schemas/WorkItems/properties/form/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/FormDetails.yaml
|
|
- nullable: true
|
|
errors:
|
|
type: array
|
|
items:
|
|
type: string
|
|
example:
|
|
- The work item ID that was specified was not found.
|
|
description: An array of errors that ocurred during the work item
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
$OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional)
|
|
|
|
# List Work Items
|
|
|
|
try {
|
|
Get-WorkItems
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-WorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItems"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/work-items/completed:
|
|
get:
|
|
operationId: getCompletedWorkItems
|
|
tags:
|
|
- Work Items
|
|
summary: Completed Work Items
|
|
description: This gets a collection of completed work items belonging to either the specified user(admin required), or the current user.
|
|
parameters:
|
|
- in: query
|
|
name: ownerId
|
|
schema:
|
|
type: string
|
|
description: The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request.
|
|
required: false
|
|
example: 1211bcaa32112bcef6122adb21cef1ac
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
responses:
|
|
'200':
|
|
description: List of completed work items.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1work-items/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/WorkItems.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional)
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
|
|
# Completed Work Items
|
|
|
|
try {
|
|
Get-CompletedWorkItems
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-CompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CompletedWorkItems"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/work-items/count:
|
|
get:
|
|
operationId: getCountWorkItems
|
|
tags:
|
|
- Work Items
|
|
summary: Count Work Items
|
|
description: This gets a count of work items belonging to either the specified user(admin required), or the current user.
|
|
parameters:
|
|
- in: query
|
|
name: ownerId
|
|
schema:
|
|
type: string
|
|
description: ID of the work item owner.
|
|
required: false
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
responses:
|
|
'200':
|
|
description: List of work items
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
description: The count of work items
|
|
example: 29
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional)
|
|
|
|
# Count Work Items
|
|
|
|
try {
|
|
Get-CountWorkItems
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-CountWorkItems -OwnerId $OwnerId
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CountWorkItems"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/work-items/completed/count:
|
|
get:
|
|
operationId: getCountCompletedWorkItems
|
|
tags:
|
|
- Work Items
|
|
summary: Count Completed Work Items
|
|
description: This gets a count of completed work items belonging to either the specified user(admin required), or the current user.
|
|
parameters:
|
|
- in: query
|
|
name: ownerId
|
|
schema:
|
|
type: string
|
|
description: ID of the work item owner.
|
|
required: false
|
|
example: 1211bcaa32112bcef6122adb21cef1ac
|
|
responses:
|
|
'200':
|
|
description: List of work items
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1work-items~1count/get/responses/200/content/application~1json/schema'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/WorkItemsCount.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional)
|
|
|
|
# Count Completed Work Items
|
|
|
|
try {
|
|
Get-CountCompletedWorkItems
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-CountCompletedWorkItems -OwnerId $OwnerId
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CountCompletedWorkItems"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/work-items/summary:
|
|
get:
|
|
operationId: getWorkItemsSummary
|
|
tags:
|
|
- Work Items
|
|
summary: Work Items Summary
|
|
description: This gets a summary of work items belonging to either the specified user(admin required), or the current user.
|
|
parameters:
|
|
- in: query
|
|
name: ownerId
|
|
schema:
|
|
type: string
|
|
description: ID of the work item owner.
|
|
required: false
|
|
example: 1211bcaa32112bcef6122adb21cef1ac
|
|
responses:
|
|
'200':
|
|
description: List of work items
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
open:
|
|
type: integer
|
|
description: The count of open work items
|
|
example: 29
|
|
completed:
|
|
type: integer
|
|
description: The count of completed work items
|
|
example: 1
|
|
total:
|
|
type: integer
|
|
description: The count of total work items
|
|
example: 30
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional)
|
|
|
|
# Work Items Summary
|
|
|
|
try {
|
|
Get-WorkItemsSummary
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-WorkItemsSummary -OwnerId $OwnerId
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItemsSummary"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/work-items/{id}:
|
|
get:
|
|
operationId: getWorkItem
|
|
tags:
|
|
- Work Items
|
|
summary: Get a Work Item
|
|
description: This gets the details of a Work Item belonging to either the specified user(admin required), or the current user.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listWorkItems
|
|
description: ID of the work item.
|
|
example: 2c9180835d191a86015d28455b4a2329
|
|
responses:
|
|
'200':
|
|
description: The work item with the given ID.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1work-items/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/WorkItems.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item.
|
|
|
|
# Get a Work Item
|
|
|
|
try {
|
|
Get-WorkItem-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-WorkItem -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItem"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
post:
|
|
operationId: completeWorkItem
|
|
tags:
|
|
- Work Items
|
|
summary: Complete a Work Item
|
|
description: This API completes a work item. Either an admin, or the owning/current user must make this request.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listWorkItems
|
|
description: The ID of the work item
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
responses:
|
|
'200':
|
|
description: A WorkItems object
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1work-items/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/WorkItems.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
|
|
|
|
# Complete a Work Item
|
|
|
|
try {
|
|
Complete-WorkItem-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Complete-WorkItem -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-WorkItem"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/work-items/{id}/forward:
|
|
post:
|
|
operationId: sendWorkItemForward
|
|
security:
|
|
- userAuth:
|
|
- idn:work-item:update
|
|
tags:
|
|
- Work Items
|
|
summary: Forward a Work Item
|
|
description: This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. Accessible to work-item Owner, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listWorkItems
|
|
description: The ID of the work item
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
required:
|
|
- targetOwnerId
|
|
- comment
|
|
properties:
|
|
targetOwnerId:
|
|
type: string
|
|
description: The ID of the identity to forward this work item to.
|
|
example: 2c9180835d2e5168015d32f890ca1581
|
|
comment:
|
|
type: string
|
|
description: Comments to send to the target owner
|
|
example: I'm going on vacation.
|
|
sendNotifications:
|
|
type: boolean
|
|
description: If true, send a notification to the target owner.
|
|
default: true
|
|
example: true
|
|
responses:
|
|
'200':
|
|
description: Success, but no data is returned.
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
|
|
$WorkItemForward = @"
|
|
{
|
|
"targetOwnerId" : "2c9180835d2e5168015d32f890ca1581",
|
|
"comment" : "I'm going on vacation.",
|
|
"sendNotifications" : true
|
|
}
|
|
"@
|
|
|
|
# Forward a Work Item
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward
|
|
Send-WorkItemForward-Id $Id -WorkItemForward $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Send-WorkItemForward -Id $Id -WorkItemForward $WorkItemForward
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-WorkItemForward"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/work-items/{id}/approve/{approvalItemId}:
|
|
post:
|
|
operationId: approveApprovalItem
|
|
tags:
|
|
- Work Items
|
|
summary: Approve an Approval Item
|
|
description: This API approves an Approval Item. Either an admin, or the owning/current user must make this request.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listWorkItems
|
|
description: The ID of the work item
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
- in: path
|
|
name: approvalItemId
|
|
schema:
|
|
type: string
|
|
required: true
|
|
description: The ID of the approval item.
|
|
example: 1211bcaa32112bcef6122adb21cef1ac
|
|
responses:
|
|
'200':
|
|
description: A work items details object.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1work-items/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/WorkItems.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
|
|
$ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item.
|
|
|
|
# Approve an Approval Item
|
|
|
|
try {
|
|
Approve-ApprovalItem-Id $Id -ApprovalItemId $ApprovalItemId
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Approve-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-ApprovalItem"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/work-items/{id}/reject/{approvalItemId}:
|
|
post:
|
|
operationId: rejectApprovalItem
|
|
tags:
|
|
- Work Items
|
|
summary: Reject an Approval Item
|
|
description: This API rejects an Approval Item. Either an admin, or the owning/current user must make this request.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listWorkItems
|
|
description: The ID of the work item
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
- in: path
|
|
name: approvalItemId
|
|
schema:
|
|
type: string
|
|
required: true
|
|
description: The ID of the approval item.
|
|
example: 1211bcaa32112bcef6122adb21cef1ac
|
|
responses:
|
|
'200':
|
|
description: A work items details object.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1work-items/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/WorkItems.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
|
|
$ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item.
|
|
|
|
# Reject an Approval Item
|
|
|
|
try {
|
|
Deny-ApprovalItem-Id $Id -ApprovalItemId $ApprovalItemId
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Deny-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-ApprovalItem"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/work-items/bulk-approve/{id}:
|
|
post:
|
|
operationId: approveApprovalItemsInBulk
|
|
tags:
|
|
- Work Items
|
|
summary: Bulk approve Approval Items
|
|
description: This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listWorkItems
|
|
description: The ID of the work item
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
responses:
|
|
'200':
|
|
description: A work items details object.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1work-items/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/WorkItems.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
|
|
|
|
# Bulk approve Approval Items
|
|
|
|
try {
|
|
Approve-ApprovalItemsInBulk-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Approve-ApprovalItemsInBulk -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-ApprovalItemsInBulk"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/work-items/bulk-reject/{id}:
|
|
post:
|
|
operationId: rejectApprovalItemsInBulk
|
|
tags:
|
|
- Work Items
|
|
summary: Bulk reject Approval Items
|
|
description: This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listWorkItems
|
|
description: The ID of the work item
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
responses:
|
|
'200':
|
|
description: A work items details object.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1work-items/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/WorkItems.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
|
|
|
|
# Bulk reject Approval Items
|
|
|
|
try {
|
|
Deny-ApprovalItemsInBulk-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Deny-ApprovalItemsInBulk -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-ApprovalItemsInBulk"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/work-items/{id}/submit-account-selection:
|
|
post:
|
|
operationId: submitAccountSelection
|
|
tags:
|
|
- Work Items
|
|
summary: Submit Account Selections
|
|
description: This API submits account selections. Either an admin, or the owning/current user must make this request.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listWorkItems
|
|
description: The ID of the work item
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
additionalProperties: true
|
|
example:
|
|
fieldName: fieldValue
|
|
description: Account Selection Data map, keyed on fieldName
|
|
responses:
|
|
'200':
|
|
description: A work items details object.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1work-items/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/WorkItems.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
|
|
$RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName
|
|
|
|
# Submit Account Selections
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
|
|
Submit-AccountSelection-Id $Id -RequestBody $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Submit-AccountSelection -Id $Id -RequestBody $RequestBody
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-AccountSelection"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/workflows:
|
|
get:
|
|
operationId: listWorkflows
|
|
tags:
|
|
- Workflows
|
|
summary: List Workflows
|
|
description: List all workflows in the tenant.
|
|
security:
|
|
- userAuth:
|
|
- sp:workflow:read
|
|
responses:
|
|
'200':
|
|
description: List of workflows
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
allOf:
|
|
- type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: Workflow ID. This is a UUID generated upon creation.
|
|
example: d201c5e9-d37b-4aff-af14-66414f39d569
|
|
executionCount:
|
|
type: integer
|
|
format: int32
|
|
description: The number of times this workflow has been executed.
|
|
example: 2
|
|
failureCount:
|
|
type: integer
|
|
format: int32
|
|
description: The number of times this workflow has failed during execution.
|
|
example: 0
|
|
created:
|
|
type: string
|
|
format: date-time
|
|
description: The date and time the workflow was created.
|
|
example: '2022-01-10T16:06:16.636381447Z'
|
|
modified:
|
|
type: string
|
|
format: date-time
|
|
description: The date and time the workflow was modified.
|
|
example: '2023-12-05T15:18:27.699Z'
|
|
modifiedBy:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
enum:
|
|
- IDENTITY
|
|
example: IDENTITY
|
|
id:
|
|
type: string
|
|
description: Identity ID
|
|
example: 2c9180a46faadee4016fb4e018c20639
|
|
name:
|
|
type: string
|
|
description: Human-readable display name of identity.
|
|
example: Thomas Edison
|
|
creator:
|
|
type: object
|
|
description: Workflow creator's identity.
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: Workflow creator's DTO type.
|
|
enum:
|
|
- IDENTITY
|
|
example: IDENTITY
|
|
id:
|
|
type: string
|
|
description: Workflow creator's identity ID.
|
|
example: 2c7180a46faadee4016fb4e018c20642
|
|
name:
|
|
type: string
|
|
description: Workflow creator's display name.
|
|
example: Michael Michaels
|
|
- $ref: '#/paths/~1workflows/post/requestBody/content/application~1json/schema/allOf/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/workflows/WorkflowBody.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
|
|
# List Workflows
|
|
|
|
try {
|
|
Get-Workflows
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-Workflows
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Workflows"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
post:
|
|
operationId: createWorkflow
|
|
tags:
|
|
- Workflows
|
|
summary: Create Workflow
|
|
description: Create a new workflow with the desired trigger and steps specified in the request body.
|
|
security:
|
|
- userAuth:
|
|
- sp:workflow:manage
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
allOf:
|
|
- required:
|
|
- name
|
|
- type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: The name of the workflow
|
|
example: Send Email
|
|
owner:
|
|
type: object
|
|
description: The identity that owns the workflow. The owner's permissions in IDN will determine what actions the workflow is allowed to perform. Ownership can be changed by updating the owner in a PUT or PATCH request.
|
|
properties:
|
|
type:
|
|
type: string
|
|
enum:
|
|
- IDENTITY
|
|
example: IDENTITY
|
|
description: The type of object that is referenced
|
|
id:
|
|
type: string
|
|
description: The unique ID of the object
|
|
example: 2c91808568c529c60168cca6f90c1313
|
|
name:
|
|
type: string
|
|
description: The name of the object
|
|
example: William Wilson
|
|
description:
|
|
type: string
|
|
description: Description of what the workflow accomplishes
|
|
example: Send an email to the identity who's attributes changed.
|
|
definition:
|
|
type: object
|
|
description: The map of steps that the workflow will execute.
|
|
properties:
|
|
start:
|
|
type: string
|
|
description: The name of the starting step.
|
|
example: Send Email Test
|
|
steps:
|
|
type: object
|
|
description: One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type.
|
|
additionalProperties: true
|
|
example:
|
|
Send Email:
|
|
actionId: sp:send-email
|
|
attributes:
|
|
body: This is a test
|
|
from: sailpoint@sailpoint.com
|
|
recipientId.$: $.identity.id
|
|
subject: test
|
|
nextStep: success
|
|
selectResult: null
|
|
type: ACTION
|
|
success:
|
|
type: success
|
|
enabled:
|
|
type: boolean
|
|
description: Enable or disable the workflow. Workflows cannot be created in an enabled state.
|
|
default: false
|
|
example: false
|
|
trigger:
|
|
type: object
|
|
description: The trigger that starts the workflow
|
|
required:
|
|
- type
|
|
- attributes
|
|
properties:
|
|
type:
|
|
type: string
|
|
enum:
|
|
- EVENT
|
|
- EXTERNAL
|
|
- SCHEDULED
|
|
- ''
|
|
example: EVENT
|
|
description: The trigger type
|
|
displayName:
|
|
type: string
|
|
nullable: true
|
|
attributes:
|
|
nullable: true
|
|
anyOf:
|
|
- title: Event Trigger Attributes
|
|
type: object
|
|
description: Attributes related to an IdentityNow ETS event
|
|
additionalProperties: false
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The unique ID of the trigger
|
|
example: idn:identity-attributes-changed
|
|
filter.$:
|
|
type: string
|
|
description: JSON path expression that will limit which events the trigger will fire on
|
|
example: $.changes[?(@.attribute == 'manager')]
|
|
description:
|
|
type: string
|
|
description: Description of the event trigger
|
|
example: Triggered when an identity's manager attribute changes
|
|
attributeToFilter:
|
|
type: string
|
|
description: The attribute to filter on
|
|
example: LifecycleState
|
|
- title: External Trigger Attributes
|
|
type: object
|
|
description: Attributes related to an external trigger
|
|
additionalProperties: false
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: A unique name for the external trigger
|
|
example: search-and-notify
|
|
description:
|
|
type: string
|
|
description: Additonal context about the external trigger
|
|
example: Run a search and notify the results
|
|
clientId:
|
|
type: string
|
|
description: OAuth Client ID to authenticate with this trigger
|
|
example: 87e239b2-b85b-4bde-b9a7-55bf304ddcdc
|
|
url:
|
|
type: string
|
|
description: URL to invoke this workflow
|
|
example: https://tenant.api.identitynow.com/beta/workflows/execute/external/c79e0079-562c-4df5-aa73-60a9e25c916d
|
|
- title: Scheduled Trigger Attributes
|
|
type: object
|
|
description: Attributes related to a scheduled trigger
|
|
additionalProperties: false
|
|
required:
|
|
- frequency
|
|
properties:
|
|
cronString:
|
|
type: string
|
|
description: A valid CRON expression
|
|
externalDocs:
|
|
description: CRON expression editor
|
|
url: https://crontab.guru/
|
|
example: 0 9 * * 1
|
|
frequency:
|
|
type: string
|
|
description: Frequency of execution
|
|
enum:
|
|
- daily
|
|
- weekly
|
|
- monthly
|
|
- yearly
|
|
- cronSchedule
|
|
timeZone:
|
|
type: string
|
|
description: Time zone identifier
|
|
example: America/Chicago
|
|
weeklyDays:
|
|
type: array
|
|
items:
|
|
type: string
|
|
example: Monday
|
|
description: Scheduled days of the week for execution
|
|
weeklyTimes:
|
|
type: array
|
|
items:
|
|
type: string
|
|
example: Monday
|
|
description: Scheduled execution times
|
|
description: Workflow Trigger Attributes.
|
|
examples:
|
|
Event Trigger:
|
|
description: Workflow initiated by an event trigger
|
|
value:
|
|
name: Send Email
|
|
owner:
|
|
type: IDENTITY
|
|
id: 2c91808568c529c60168cca6f90c1313
|
|
name: William Wilson
|
|
description: Send an email to the identity who's attributes changed.
|
|
definition:
|
|
start: Send Email Test
|
|
steps:
|
|
Send Email:
|
|
actionId: sp:send-email
|
|
attributes:
|
|
body: This is a test
|
|
from: sailpoint@sailpoint.com
|
|
recipientId.$: $.identity.id
|
|
subject: test
|
|
nextStep: success
|
|
selectResult: null
|
|
type: action
|
|
success:
|
|
type: success
|
|
enabled: false
|
|
trigger:
|
|
type: EVENT
|
|
attributes:
|
|
id: idn:identity-attributes-changed
|
|
filter: $.changes[?(@.attribute == 'manager')]
|
|
Scheduled Trigger:
|
|
description: Workflow initiated by a scheduled trigger
|
|
value:
|
|
name: Send Email
|
|
owner:
|
|
type: IDENTITY
|
|
id: 2c91808568c529c60168cca6f90c1313
|
|
name: William Wilson
|
|
description: Send an email to the identity who's attributes changed.
|
|
definition:
|
|
start: Send Email Test
|
|
steps:
|
|
Send Email:
|
|
actionId: sp:send-email
|
|
attributes:
|
|
body: This is a test
|
|
from: sailpoint@sailpoint.com
|
|
recipientId.$: $.identity.id
|
|
subject: test
|
|
nextStep: success
|
|
selectResult: null
|
|
type: action
|
|
success:
|
|
type: success
|
|
enabled: false
|
|
trigger:
|
|
type: SCHEDULED
|
|
attributes:
|
|
cronString: 0 * */3 */5 *
|
|
External Trigger:
|
|
description: Workflow initiated by an external trigger
|
|
value:
|
|
name: Send Email
|
|
owner:
|
|
type: IDENTITY
|
|
id: 2c91808568c529c60168cca6f90c1313
|
|
name: William Wilson
|
|
description: Send an email to the identity whose attributes changed.
|
|
definition:
|
|
start: Send Email Test
|
|
steps:
|
|
Send Email:
|
|
actionId: sp:send-email
|
|
attributes:
|
|
body: This is a test
|
|
from: sailpoint@sailpoint.com
|
|
recipientId.$: $.identity.id
|
|
subject: test
|
|
nextStep: success
|
|
selectResult: null
|
|
type: action
|
|
success:
|
|
type: success
|
|
enabled: false
|
|
trigger:
|
|
type: EXTERNAL
|
|
attributes:
|
|
name: search-and-notify
|
|
description: Run a search and notify the results
|
|
responses:
|
|
'200':
|
|
description: The Workflow object
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1workflows/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/workflows/Workflow.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$CreateWorkflowRequest = @"
|
|
{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}
|
|
"@
|
|
|
|
# Create Workflow
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest
|
|
New-Workflow-CreateWorkflowRequest $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# New-Workflow -CreateWorkflowRequest $CreateWorkflowRequest
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Workflow"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/workflows/{id}:
|
|
get:
|
|
operationId: getWorkflow
|
|
tags:
|
|
- Workflows
|
|
summary: Get Workflow By Id
|
|
description: Get a single workflow by id.
|
|
security:
|
|
- userAuth:
|
|
- sp:workflow:read
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Id of the workflow
|
|
required: true
|
|
style: simple
|
|
explode: false
|
|
schema:
|
|
type: string
|
|
example: c17bea3a-574d-453c-9e04-4365fbf5af0b
|
|
responses:
|
|
'200':
|
|
description: The workflow object
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1workflows/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/workflows/Workflow.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow
|
|
|
|
# Get Workflow By Id
|
|
|
|
try {
|
|
Get-Workflow-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-Workflow -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Workflow"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
put:
|
|
operationId: putWorkflow
|
|
tags:
|
|
- Workflows
|
|
summary: Update Workflow
|
|
description: Perform a full update of a workflow. The updated workflow object is returned in the response.
|
|
security:
|
|
- userAuth:
|
|
- sp:workflow:manage
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Id of the Workflow
|
|
required: true
|
|
style: simple
|
|
explode: false
|
|
schema:
|
|
type: string
|
|
example: c17bea3a-574d-453c-9e04-4365fbf5af0b
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1workflows/post/requestBody/content/application~1json/schema/allOf/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/workflows/WorkflowBody.yaml
|
|
responses:
|
|
'200':
|
|
description: The Workflow object
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1workflows/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/workflows/Workflow.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow
|
|
$WorkflowBody = @"
|
|
{
|
|
"owner" : {
|
|
"name" : "William Wilson",
|
|
"id" : "2c91808568c529c60168cca6f90c1313",
|
|
"type" : "IDENTITY"
|
|
},
|
|
"name" : "Send Email",
|
|
"description" : "Send an email to the identity who's attributes changed.",
|
|
"definition" : {
|
|
"start" : "Send Email Test",
|
|
"steps" : {
|
|
"Send Email" : {
|
|
"actionId" : "sp:send-email",
|
|
"attributes" : {
|
|
"body" : "This is a test",
|
|
"from" : "sailpoint@sailpoint.com",
|
|
"recipientId.$" : "$.identity.id",
|
|
"subject" : "test"
|
|
},
|
|
"nextStep" : "success",
|
|
"type" : "ACTION"
|
|
},
|
|
"success" : {
|
|
"type" : "success"
|
|
}
|
|
}
|
|
},
|
|
"trigger" : {
|
|
"displayName" : "displayName",
|
|
"attributes" : {
|
|
"description" : "Triggered when an identity's manager attribute changes",
|
|
"attributeToFilter" : "LifecycleState",
|
|
"id" : "idn:identity-attributes-changed",
|
|
"filter.$" : "$.changes[?(@.attribute == 'manager')]"
|
|
},
|
|
"type" : "EVENT"
|
|
},
|
|
"enabled" : false
|
|
}
|
|
"@
|
|
|
|
# Update Workflow
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody
|
|
Send-Workflow-Id $Id -WorkflowBody $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Send-Workflow -Id $Id -WorkflowBody $WorkflowBody
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-Workflow"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
patch:
|
|
operationId: patchWorkflow
|
|
tags:
|
|
- Workflows
|
|
summary: Patch Workflow
|
|
description: Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
|
|
security:
|
|
- userAuth:
|
|
- sp:workflow:manage
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Id of the Workflow
|
|
required: true
|
|
style: simple
|
|
explode: false
|
|
schema:
|
|
type: string
|
|
example: c17bea3a-574d-453c-9e04-4365fbf5af0b
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json-patch+json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/JsonPatchOperation.yaml
|
|
examples:
|
|
Update all patchable fields:
|
|
description: Demonstrate how to update each patchable field in one PATCH request.
|
|
value:
|
|
- op: replace
|
|
path: /name
|
|
value: Send Email
|
|
- op: replace
|
|
path: /owner
|
|
value:
|
|
type: IDENTITY
|
|
id: 2c91808568c529c60168cca6f90c1313
|
|
name: William Wilson
|
|
- op: replace
|
|
path: /description
|
|
value: Send an email to the identity who's attributes changed.
|
|
- op: replace
|
|
path: /enabled
|
|
value: false
|
|
- op: replace
|
|
path: /definition
|
|
value:
|
|
start: Send Email Test
|
|
steps:
|
|
Send Email:
|
|
actionId: sp:send-email
|
|
attributes:
|
|
body: This is a test
|
|
from: sailpoint@sailpoint.com
|
|
recipientId.$: $.identity.id
|
|
subject: test
|
|
nextStep: success
|
|
selectResult: null
|
|
type: action
|
|
success:
|
|
type: success
|
|
- op: replace
|
|
path: /trigger
|
|
value:
|
|
type: EVENT
|
|
attributes:
|
|
id: idn:identity-attributes-changed
|
|
responses:
|
|
'200':
|
|
description: The Workflow object
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1workflows/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/workflows/Workflow.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow
|
|
# JsonPatchOperation[] |
|
|
$JsonPatchOperation = @"{
|
|
"op" : "replace",
|
|
"path" : "/description",
|
|
"value" : "New description"
|
|
}"@
|
|
|
|
|
|
# Patch Workflow
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
|
|
Update-Workflow-Id $Id -JsonPatchOperation $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Update-Workflow -Id $Id -JsonPatchOperation $JsonPatchOperation
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Workflow"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
delete:
|
|
operationId: deleteWorkflow
|
|
tags:
|
|
- Workflows
|
|
summary: Delete Workflow By Id
|
|
description: Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled.
|
|
security:
|
|
- userAuth:
|
|
- sp:workflow:manage
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Id of the Workflow
|
|
required: true
|
|
style: simple
|
|
explode: false
|
|
schema:
|
|
type: string
|
|
example: c17bea3a-574d-453c-9e04-4365fbf5af0b
|
|
responses:
|
|
'204':
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/204.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow
|
|
|
|
# Delete Workflow By Id
|
|
|
|
try {
|
|
Remove-Workflow-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Remove-Workflow -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Workflow"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/workflows/{id}/test:
|
|
post:
|
|
operationId: testWorkflow
|
|
tags:
|
|
- Workflows
|
|
summary: Test Workflow By Id
|
|
description: |-
|
|
Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/idn/docs/event-triggers/available) for an example input for the trigger that initiates this workflow.
|
|
This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint.
|
|
**This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.**
|
|
security:
|
|
- userAuth:
|
|
- sp:workflow-execute:external
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Id of the workflow
|
|
required: true
|
|
style: simple
|
|
explode: false
|
|
schema:
|
|
type: string
|
|
example: c17bea3a-574d-453c-9e04-4365fbf5af0b
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
required:
|
|
- input
|
|
properties:
|
|
input:
|
|
type: object
|
|
description: The test input for the workflow.
|
|
examples:
|
|
Identity Attributes Changed:
|
|
description: Identity Attributes Changed Trigger Input
|
|
value:
|
|
input:
|
|
identity:
|
|
id: ee769173319b41d19ccec6cea52f237b
|
|
name: john.doe
|
|
type: IDENTITY
|
|
changes:
|
|
- attribute: department
|
|
oldValue: sales
|
|
newValue: marketing
|
|
- attribute: manager
|
|
oldValue:
|
|
id: ee769173319b41d19ccec6c235423237b
|
|
name: nice.guy
|
|
type: IDENTITY
|
|
newValue:
|
|
id: ee769173319b41d19ccec6c235423236c
|
|
name: mean.guy
|
|
type: IDENTITY
|
|
- attribute: email
|
|
oldValue: john.doe@hotmail.com
|
|
newValue: john.doe@gmail.com
|
|
responses:
|
|
'200':
|
|
description: The Workflow object
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
workflowExecutionId:
|
|
type: string
|
|
description: The workflow execution id
|
|
example: 0e11cefa-96e7-4b67-90d0-065bc1da5753
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow
|
|
$TestWorkflowRequest = @"
|
|
{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}
|
|
"@
|
|
|
|
# Test Workflow By Id
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest
|
|
Test-Workflow-Id $Id -TestWorkflowRequest $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Test-Workflow -Id $Id -TestWorkflowRequest $TestWorkflowRequest
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-Workflow"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/workflows/{id}/executions:
|
|
get:
|
|
operationId: getWorkflowExecutions
|
|
tags:
|
|
- Workflows
|
|
summary: List Workflow Executions
|
|
description: |-
|
|
Use this API to list a specified workflow's executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following:
|
|
1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows.
|
|
2. Get your workflow ID from the response.
|
|
3. You can then do either of the following:
|
|
|
|
- Filter to find relevant workflow executions.
|
|
For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq "Failed"`
|
|
|
|
- Paginate through results with the `offset` parameter.
|
|
For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250.
|
|
Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination.
|
|
security:
|
|
- userAuth:
|
|
- sp:workflow:read
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Workflow ID.
|
|
required: true
|
|
style: simple
|
|
explode: false
|
|
schema:
|
|
type: string
|
|
example: c17bea3a-574d-453c-9e04-4365fbf5af0b
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
- in: query
|
|
name: filters
|
|
schema:
|
|
type: string
|
|
description: |-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
**start_time**: *eq, lt, le, gt, ge*
|
|
|
|
**status**: *eq*
|
|
example: status eq "Failed"
|
|
required: false
|
|
responses:
|
|
'200':
|
|
description: List of workflow executions for the specified workflow.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: Workflow execution ID.
|
|
example: b393f4e2-4785-4d7f-ab27-3a6b8ded4c81
|
|
workflowId:
|
|
type: string
|
|
description: Workflow ID.
|
|
example: d201c5d9-d37b-4a2f-af14-66414f39d568
|
|
requestId:
|
|
type: string
|
|
description: Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes.
|
|
example: 41e12a74fa7b4a6a98ae47887b64acdb
|
|
startTime:
|
|
type: string
|
|
format: date-time
|
|
description: Date/time when the workflow started.
|
|
example: '2022-02-07T20:13:29.356648026Z'
|
|
closeTime:
|
|
type: string
|
|
format: date-time
|
|
description: Date/time when the workflow ended.
|
|
example: '2022-02-07T20:13:31.682410165Z'
|
|
status:
|
|
description: Workflow execution status.
|
|
type: string
|
|
enum:
|
|
- Completed
|
|
- Failed
|
|
- Canceled
|
|
- Executing
|
|
example: Completed
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID.
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
$Filters = "status eq "Failed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional)
|
|
|
|
# List Workflow Executions
|
|
|
|
try {
|
|
Get-WorkflowExecutions-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecutions"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/workflow-executions/{id}:
|
|
get:
|
|
operationId: getWorkflowExecution
|
|
tags:
|
|
- Workflows
|
|
summary: Get Workflow Execution
|
|
description: Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response.
|
|
security:
|
|
- userAuth:
|
|
- sp:workflow:read
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Workflow execution ID.
|
|
required: true
|
|
style: simple
|
|
explode: false
|
|
schema:
|
|
type: string
|
|
example: c17bea3a-574d-453c-9e04-4365fbf5af0b
|
|
responses:
|
|
'200':
|
|
description: Workflow execution.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
items:
|
|
$ref: '#/paths/~1workflows~1%7Bid%7D~1executions/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/workflows/WorkflowExecution.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID.
|
|
|
|
# Get Workflow Execution
|
|
|
|
try {
|
|
Get-WorkflowExecution-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-WorkflowExecution -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecution"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/workflow-executions/{id}/history:
|
|
get:
|
|
operationId: getWorkflowExecutionHistory
|
|
tags:
|
|
- Workflows
|
|
summary: Get Workflow Execution History
|
|
description: Get a detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found.
|
|
security:
|
|
- userAuth:
|
|
- sp:workflow:read
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Id of the workflow execution
|
|
required: true
|
|
style: simple
|
|
explode: false
|
|
schema:
|
|
type: string
|
|
example: c17bea3a-574d-453c-9e04-4365fbf5af0b
|
|
responses:
|
|
'200':
|
|
description: List of workflow execution events for the given workflow execution
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: The type of event
|
|
enum:
|
|
- WorkflowExecutionScheduled
|
|
- WorkflowExecutionStarted
|
|
- WorkflowExecutionCompleted
|
|
- WorkflowExecutionFailed
|
|
- WorkflowTaskScheduled
|
|
- WorkflowTaskStarted
|
|
- WorkflowTaskCompleted
|
|
- WorkflowTaskFailed
|
|
- ActivityTaskScheduled
|
|
- ActivityTaskStarted
|
|
- ActivityTaskCompleted
|
|
- ActivityTaskFailed
|
|
- StartChildWorkflowExecutionInitiated
|
|
- ChildWorkflowExecutionStarted
|
|
- ChildWorkflowExecutionCompleted
|
|
- ChildWorkflowExecutionFailed
|
|
example: WorkflowTaskScheduled
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
description: The date-time when the event occurred
|
|
example: '2022-02-07T20:13:31.640618296Z'
|
|
attributes:
|
|
type: object
|
|
description: Additional attributes associated with the event
|
|
example: {}
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution
|
|
|
|
# Get Workflow Execution History
|
|
|
|
try {
|
|
Get-WorkflowExecutionHistory-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-WorkflowExecutionHistory -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecutionHistory"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/workflow-executions/{id}/cancel:
|
|
post:
|
|
operationId: cancelWorkflowExecution
|
|
tags:
|
|
- Workflows
|
|
summary: Cancel Workflow Execution by ID
|
|
description: Use this API to cancel a running workflow execution.
|
|
security:
|
|
- userAuth:
|
|
- sp:workflow-execute:external
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: The workflow execution ID
|
|
required: true
|
|
style: simple
|
|
explode: false
|
|
schema:
|
|
type: string
|
|
example: c17bea3a-574d-453c-9e04-4365fbf5af0b
|
|
responses:
|
|
'204':
|
|
$ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/204.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID
|
|
|
|
# Cancel Workflow Execution by ID
|
|
|
|
try {
|
|
Suspend-WorkflowExecution-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Suspend-WorkflowExecution -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-WorkflowExecution"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/workflow-library:
|
|
get:
|
|
operationId: listCompleteWorkflowLibrary
|
|
tags:
|
|
- Workflows
|
|
summary: List Complete Workflow Library
|
|
description: This lists all triggers, actions, and operators in the library
|
|
externalDocs:
|
|
description: Additional documentation for workflows
|
|
url: https://documentation.sailpoint.com/saas/help/workflows/workflow-steps.html
|
|
parameters:
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
security:
|
|
- userAuth:
|
|
- sp:workflow:read
|
|
responses:
|
|
'200':
|
|
description: List of workflow steps
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
anyOf:
|
|
- title: Workflow Action
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: Action ID. This is a static namespaced ID for the action
|
|
example: sp:create-campaign
|
|
name:
|
|
type: string
|
|
description: Action Name
|
|
example: Create Certification Campaign
|
|
type:
|
|
type: string
|
|
description: Action type
|
|
example: ACTION
|
|
description:
|
|
type: string
|
|
description: Action Description
|
|
example: Generates a certification campaign.
|
|
formFields:
|
|
nullable: true
|
|
type: array
|
|
description: One or more inputs that the action accepts
|
|
items:
|
|
type: object
|
|
properties:
|
|
description:
|
|
type: string
|
|
description: Description of the form field
|
|
example: First value to compare
|
|
helpText:
|
|
type: string
|
|
description: Describes the form field in the UI
|
|
example: The name to give to this certification campaign.
|
|
label:
|
|
type: string
|
|
description: A human readable name for this form field in the UI
|
|
example: Campaign Name
|
|
name:
|
|
type: string
|
|
description: The name of the input attribute
|
|
example: name
|
|
required:
|
|
type: boolean
|
|
description: Denotes if this field is a required attribute
|
|
example: false
|
|
default: false
|
|
type:
|
|
description: The type of the form field
|
|
type: string
|
|
nullable: true
|
|
enum:
|
|
- text
|
|
- textarea
|
|
- boolean
|
|
- email
|
|
- url
|
|
- number
|
|
- json
|
|
- checkbox
|
|
- jsonpath
|
|
- select
|
|
- multiType
|
|
- duration
|
|
- toggle
|
|
- formPicker
|
|
- identityPicker
|
|
- governanceGroupPicker
|
|
- string
|
|
- object
|
|
- array
|
|
- secret
|
|
- keyValuePairs
|
|
- emailPicker
|
|
- advancedToggle
|
|
- variableCreator
|
|
- htmlEditor
|
|
example: text
|
|
exampleOutput:
|
|
oneOf:
|
|
- type: object
|
|
description: Example output
|
|
- type: array
|
|
items:
|
|
type: object
|
|
deprecated:
|
|
type: boolean
|
|
deprecatedBy:
|
|
type: string
|
|
format: date-time
|
|
versionNumber:
|
|
type: integer
|
|
description: Version number
|
|
isSimulationEnabled:
|
|
type: boolean
|
|
isDynamicSchema:
|
|
type: boolean
|
|
description: Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields.
|
|
example: false
|
|
default: false
|
|
outputSchema:
|
|
type: object
|
|
description: Defines the output schema, if any, that this action produces.
|
|
example:
|
|
definitions: {}
|
|
properties:
|
|
autoRevokeAllowed:
|
|
$id: '#sp:create-campaign/autoRevokeAllowed'
|
|
default: true
|
|
examples:
|
|
- false
|
|
title: autoRevokeAllowed
|
|
type: boolean
|
|
deadline:
|
|
$id: '#sp:create-campaign/deadline'
|
|
default: ''
|
|
examples:
|
|
- '2020-12-25T06:00:00.468Z'
|
|
format: date-time
|
|
pattern: ^.*$
|
|
title: deadline
|
|
type: string
|
|
description:
|
|
$id: '#sp:create-campaign/description'
|
|
default: ''
|
|
examples:
|
|
- A review of everyone's access by their manager.
|
|
pattern: ^.*$
|
|
title: description
|
|
type: string
|
|
emailNotificationEnabled:
|
|
$id: '#sp:create-campaign/emailNotificationEnabled'
|
|
default: true
|
|
examples:
|
|
- false
|
|
title: emailNotificationEnabled
|
|
type: boolean
|
|
filter:
|
|
$id: '#sp:create-campaign/filter'
|
|
properties:
|
|
id:
|
|
$id: '#sp:create-campaign/filter/id'
|
|
default: ''
|
|
examples:
|
|
- e0adaae69852e8fe8b8a3d48e5ce757c
|
|
pattern: ^.*$
|
|
title: id
|
|
type: string
|
|
type:
|
|
$id: '#sp:create-campaign/filter/type'
|
|
default: ''
|
|
examples:
|
|
- CAMPAIGN_FILTER
|
|
pattern: ^.*$
|
|
title: type
|
|
type: string
|
|
title: filter
|
|
type: object
|
|
id:
|
|
$id: '#sp:create-campaign/id'
|
|
default: ''
|
|
examples:
|
|
- 2c918086719eec070171a7e3355a360a
|
|
pattern: ^.*$
|
|
title: id
|
|
type: string
|
|
name:
|
|
$id: '#sp:create-campaign/name'
|
|
default: ''
|
|
examples:
|
|
- Manager Review
|
|
pattern: ^.*$
|
|
title: name
|
|
type: string
|
|
recommendationsEnabled:
|
|
$id: '#sp:create-campaign/recommendationsEnabled'
|
|
default: true
|
|
examples:
|
|
- false
|
|
title: recommendationEnabled
|
|
type: boolean
|
|
type:
|
|
$id: '#sp:create-campaign/type'
|
|
default: ''
|
|
examples:
|
|
- MANAGER
|
|
pattern: ^.*$
|
|
title: type
|
|
type: string
|
|
title: sp:create-campaign
|
|
type: object
|
|
- title: Workflow Trigger
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: Trigger ID. This is a static namespaced ID for the trigger.
|
|
example: idn:identity-attributes-changed
|
|
type:
|
|
description: Trigger type
|
|
type: string
|
|
enum:
|
|
- EVENT
|
|
- SCHEDULED
|
|
- EXTERNAL
|
|
example: EVENT
|
|
deprecated:
|
|
type: boolean
|
|
deprecatedBy:
|
|
type: string
|
|
format: date-time
|
|
isSimulationEnabled:
|
|
type: boolean
|
|
outputSchema:
|
|
type: object
|
|
description: Example output schema
|
|
name:
|
|
type: string
|
|
description: Trigger Name
|
|
example: Identity Attributes Changed
|
|
description:
|
|
type: string
|
|
description: Trigger Description
|
|
example: One or more identity attributes changed.
|
|
isDynamicSchema:
|
|
type: boolean
|
|
description: Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields.
|
|
example: false
|
|
default: false
|
|
inputExample:
|
|
type: object
|
|
description: Example trigger payload if applicable
|
|
nullable: true
|
|
externalDocs:
|
|
description: List of triggers and their input schemas
|
|
url: https://developer.sailpoint.com/idn/docs/event-triggers/available
|
|
example:
|
|
changes:
|
|
- attribute: department
|
|
newValue: marketing
|
|
oldValue: sales
|
|
- attribute: manager
|
|
newValue:
|
|
id: ee769173319b41d19ccec6c235423236c
|
|
name: mean.guy
|
|
type: IDENTITY
|
|
oldValue:
|
|
id: ee769173319b41d19ccec6c235423237b
|
|
name: nice.guy
|
|
type: IDENTITY
|
|
- attribute: email
|
|
newValue: john.doe@gmail.com
|
|
oldValue: john.doe@hotmail.com
|
|
identity:
|
|
id: ee769173319b41d19ccec6cea52f237b
|
|
name: john.doe
|
|
type: IDENTITY
|
|
formFields:
|
|
type: array
|
|
nullable: true
|
|
description: One or more inputs that the trigger accepts
|
|
example: []
|
|
items:
|
|
$ref: '#/paths/~1workflow-library/get/responses/200/content/application~1json/schema/items/anyOf/0/properties/formFields/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/workflows/WorkflowLibraryFormFields.yaml
|
|
- title: Workflow Operator
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: Operator ID.
|
|
example: sp:compare-boolean
|
|
name:
|
|
type: string
|
|
description: Operator friendly name
|
|
example: Compare Boolean Values
|
|
type:
|
|
description: Operator type
|
|
type: string
|
|
example: OPERATOR
|
|
description:
|
|
type: string
|
|
description: Description of the operator
|
|
example: Compare two boolean values and decide what happens based on the result.
|
|
isDynamicSchema:
|
|
type: boolean
|
|
description: Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields.
|
|
example: false
|
|
deprecated:
|
|
type: boolean
|
|
deprecatedBy:
|
|
type: string
|
|
format: date-time
|
|
isSimulationEnabled:
|
|
type: boolean
|
|
formFields:
|
|
type: array
|
|
nullable: true
|
|
description: One or more inputs that the operator accepts
|
|
items:
|
|
$ref: '#/paths/~1workflow-library/get/responses/200/content/application~1json/schema/items/anyOf/0/properties/formFields/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/workflows/WorkflowLibraryFormFields.yaml
|
|
example:
|
|
- description: Enter the JSONPath to a value from the input to compare to Variable B.
|
|
helpText: ''
|
|
label: Variable A
|
|
name: variableA.$
|
|
required: true
|
|
type: text
|
|
- helpText: Select an operation.
|
|
label: Operation
|
|
name: operator
|
|
options:
|
|
- label: Equals
|
|
value: BooleanEquals
|
|
required: true
|
|
type: select
|
|
- description: Enter the JSONPath to a value from the input to compare to Variable A.
|
|
helpText: ''
|
|
label: Variable B
|
|
name: variableB.$
|
|
required: false
|
|
type: text
|
|
- description: Enter True or False.
|
|
helpText: ''
|
|
label: Variable B
|
|
name: variableB
|
|
required: false
|
|
type: text
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
|
|
# List Complete Workflow Library
|
|
|
|
try {
|
|
Get-CompleteWorkflowLibrary
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-CompleteWorkflowLibrary -Limit $Limit -Offset $Offset
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CompleteWorkflowLibrary"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/workflow-library/actions:
|
|
get:
|
|
operationId: listWorkflowLibraryActions
|
|
tags:
|
|
- Workflows
|
|
summary: List Workflow Library Actions
|
|
description: This lists the workflow actions available to you.
|
|
externalDocs:
|
|
description: Additional documentation for each action
|
|
url: https://documentation.sailpoint.com/saas/help/workflows/workflow-steps.html#actions
|
|
parameters:
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- in: query
|
|
name: filters
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: |-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
**id**: *eq*
|
|
example: id eq "sp:create-campaign"
|
|
security:
|
|
- userAuth:
|
|
- sp:workflow:read
|
|
responses:
|
|
'200':
|
|
description: List of workflow actions
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1workflow-library/get/responses/200/content/application~1json/schema/items/anyOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/workflows/WorkflowLibraryAction.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Filters = "id eq "sp:create-campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional)
|
|
|
|
# List Workflow Library Actions
|
|
|
|
try {
|
|
Get-WorkflowLibraryActions
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowLibraryActions"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/workflow-library/triggers:
|
|
get:
|
|
operationId: listWorkflowLibraryTriggers
|
|
tags:
|
|
- Workflows
|
|
summary: List Workflow Library Triggers
|
|
description: This lists the workflow triggers available to you
|
|
externalDocs:
|
|
description: Additional documentation for each trigger
|
|
url: https://documentation.sailpoint.com/saas/help/workflows/workflow-steps.html#triggers
|
|
parameters:
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- in: query
|
|
name: filters
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: |-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
**id**: *eq*
|
|
example: id eq "idn:identity-attributes-changed"
|
|
security:
|
|
- userAuth:
|
|
- sp:workflow:read
|
|
responses:
|
|
'200':
|
|
description: List of workflow triggers
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1workflow-library/get/responses/200/content/application~1json/schema/items/anyOf/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/workflows/WorkflowLibraryTrigger.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Filters = "id eq "idn:identity-attributes-changed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional)
|
|
|
|
# List Workflow Library Triggers
|
|
|
|
try {
|
|
Get-WorkflowLibraryTriggers
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowLibraryTriggers"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/workflow-library/operators:
|
|
get:
|
|
operationId: listWorkflowLibraryOperators
|
|
tags:
|
|
- Workflows
|
|
summary: List Workflow Library Operators
|
|
description: This lists the workflow operators available to you
|
|
security:
|
|
- userAuth:
|
|
- sp:workflow:read
|
|
responses:
|
|
'200':
|
|
description: List of workflow operators
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/paths/~1workflow-library/get/responses/200/content/application~1json/schema/items/anyOf/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/workflows/WorkflowLibraryOperator.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
|
|
# List Workflow Library Operators
|
|
|
|
try {
|
|
Get-WorkflowLibraryOperators
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-WorkflowLibraryOperators
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowLibraryOperators"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/workflows/{id}/external/oauth-clients:
|
|
post:
|
|
operationId: createWorkflowExternalTrigger
|
|
tags:
|
|
- Workflows
|
|
summary: Generate External Trigger OAuth Client
|
|
description: Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow.
|
|
security:
|
|
- userAuth:
|
|
- sp:workflow:manage
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Id of the workflow
|
|
required: true
|
|
style: simple
|
|
explode: false
|
|
schema:
|
|
type: string
|
|
example: c17bea3a-574d-453c-9e04-4365fbf5af0b
|
|
responses:
|
|
'200':
|
|
description: The OAuth Client object
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: OAuth client ID for the trigger. This is a UUID generated upon creation.
|
|
example: 1a58c03a6bf64dc2876f6988c6e2c7b7
|
|
secret:
|
|
type: string
|
|
description: OAuthClient secret.
|
|
example: 00cc24a7fe810fe06a7cb38bc168ae104d703c7abb296f9944dc68e69ddb578b
|
|
url:
|
|
type: string
|
|
description: URL for the external trigger to invoke
|
|
example: https://tenant.api.identitynow.com/beta/workflows/execute/external/c17bea3a-574d-453c-9e04-4365fbf5af0b
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow
|
|
|
|
# Generate External Trigger OAuth Client
|
|
|
|
try {
|
|
New-WorkflowExternalTrigger-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# New-WorkflowExternalTrigger -Id $Id
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-WorkflowExternalTrigger"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/workflows/execute/external/{id}:
|
|
post:
|
|
operationId: createExternalExecuteWorkflow
|
|
tags:
|
|
- Workflows
|
|
summary: Execute Workflow via External Trigger
|
|
description: This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the "External Trigger" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body.
|
|
security:
|
|
- userAuth:
|
|
- sp:workflow-execute:external
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Id of the workflow
|
|
required: true
|
|
style: simple
|
|
explode: false
|
|
schema:
|
|
type: string
|
|
example: c17bea3a-574d-453c-9e04-4365fbf5af0b
|
|
requestBody:
|
|
required: false
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
input:
|
|
type: object
|
|
description: The input for the workflow
|
|
example:
|
|
customAttribute1: value1
|
|
customAttribute2: value2
|
|
responses:
|
|
'200':
|
|
description: The Workflow object
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
workflowExecutionId:
|
|
type: string
|
|
description: The workflow execution id
|
|
example: 0e11cefa-96e7-4b67-90d0-065bc1da5753
|
|
message:
|
|
type: string
|
|
description: An error message if any errors occurred
|
|
example: Workflow was not executed externally. Check enabled flag on workflow definition
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow
|
|
$CreateExternalExecuteWorkflowRequest = @"
|
|
|
|
"@
|
|
|
|
# Execute Workflow via External Trigger
|
|
|
|
try {
|
|
New-ExternalExecuteWorkflow-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# New-ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $CreateExternalExecuteWorkflowRequest
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ExternalExecuteWorkflow"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/workflows/execute/external/{id}/test:
|
|
post:
|
|
operationId: testExternalExecuteWorkflow
|
|
tags:
|
|
- Workflows
|
|
summary: Test Workflow via External Trigger
|
|
description: Validate a workflow with an "External Trigger" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow.
|
|
security:
|
|
- userAuth:
|
|
- sp:workflow-execute:external
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Id of the workflow
|
|
required: true
|
|
style: simple
|
|
explode: false
|
|
schema:
|
|
type: string
|
|
example: c17bea3a-574d-453c-9e04-4365fbf5af0b
|
|
requestBody:
|
|
required: false
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
input:
|
|
type: object
|
|
description: The test input for the workflow
|
|
example:
|
|
test: hello world
|
|
responses:
|
|
'200':
|
|
description: Responds with the test input
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
payload:
|
|
type: object
|
|
description: The input that was received
|
|
example:
|
|
test: hello world
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow
|
|
$TestExternalExecuteWorkflowRequest = @"
|
|
|
|
"@
|
|
|
|
# Test Workflow via External Trigger
|
|
|
|
try {
|
|
Test-ExternalExecuteWorkflow-Id $Id
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Test-ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $TestExternalExecuteWorkflowRequest
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-ExternalExecuteWorkflow"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/source-usages/{sourceId}/status:
|
|
get:
|
|
tags:
|
|
- Source Usages
|
|
summary: Finds status of source usage
|
|
description: This API returns the status of the source usage insights setup by IDN source ID.
|
|
operationId: getStatusBySourceId
|
|
parameters:
|
|
- name: sourceId
|
|
in: path
|
|
description: ID of IDN source
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listSources
|
|
schema:
|
|
type: string
|
|
example: 2c9180835d191a86015d28455b4a2329
|
|
security:
|
|
- userAuth:
|
|
- idn:accounts:read
|
|
responses:
|
|
'200':
|
|
description: Status of the source usage insights setup by IDN source ID.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
status:
|
|
type: string
|
|
description: |-
|
|
Source Usage Status. Acceptable values are:
|
|
- COMPLETE
|
|
- This status means that an activity data source has been setup and usage insights are available for the source.
|
|
- INCOMPLETE
|
|
- This status means that an activity data source has not been setup and usage insights are not available for the source.
|
|
example: COMPLETE
|
|
enum:
|
|
- COMPLETE
|
|
- INCOMPLETE
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source
|
|
|
|
# Finds status of source usage
|
|
|
|
try {
|
|
Get-StatusBySourceId-SourceId $SourceId
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-StatusBySourceId -SourceId $SourceId
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-StatusBySourceId"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/source-usages/{sourceId}/summaries:
|
|
get:
|
|
tags:
|
|
- Source Usages
|
|
summary: Returns source usage insights
|
|
description: This API returns a summary of source usage insights for past 12 months.
|
|
operationId: getUsagesBySourceId
|
|
parameters:
|
|
- name: sourceId
|
|
in: path
|
|
description: ID of IDN source
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listSources
|
|
schema:
|
|
type: string
|
|
example: 2c9180835d191a86015d28455b4a2329
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
- in: query
|
|
name: sorters
|
|
schema:
|
|
type: string
|
|
format: comma-separated
|
|
description: |-
|
|
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
|
|
|
Sorting is supported for the following fields: **date**
|
|
example: '-date'
|
|
security:
|
|
- userAuth:
|
|
- idn:accounts:read
|
|
responses:
|
|
'200':
|
|
description: Summary of source usage insights for past 12 months.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
date:
|
|
type: string
|
|
format: date
|
|
description: The first day of the month for which activity is aggregated.
|
|
example: '2023-04-21'
|
|
count:
|
|
type: number
|
|
format: float
|
|
description: The average number of days that accounts were active within this source, for the month.
|
|
example: 10.45
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
$Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional)
|
|
|
|
# Returns source usage insights
|
|
|
|
try {
|
|
Get-UsagesBySourceId-SourceId $SourceId
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UsagesBySourceId"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/account-usages/{accountId}/summaries:
|
|
get:
|
|
tags:
|
|
- Account Usages
|
|
summary: Returns account usage insights
|
|
description: This API returns a summary of account usage insights for past 12 months.
|
|
operationId: getUsagesByAccountId
|
|
parameters:
|
|
- name: accountId
|
|
in: path
|
|
description: ID of IDN account
|
|
required: true
|
|
x-sailpoint-resource-operation-id: listAccounts
|
|
schema:
|
|
type: string
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/3'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml
|
|
- in: query
|
|
name: sorters
|
|
schema:
|
|
type: string
|
|
format: comma-separated
|
|
description: |-
|
|
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
|
|
|
Sorting is supported for the following fields: **date**
|
|
example: '-date'
|
|
security:
|
|
- userAuth:
|
|
- idn:accounts:read
|
|
responses:
|
|
'200':
|
|
description: Summary of account usage insights for past 12 months.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
date:
|
|
type: string
|
|
format: date
|
|
description: The first day of the month for which activity is aggregated.
|
|
example: '2023-04-21'
|
|
count:
|
|
type: integer
|
|
format: int64
|
|
description: The number of days within the month that the account was active in a source.
|
|
example: 10
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
|
$Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional)
|
|
|
|
# Returns account usage insights
|
|
|
|
try {
|
|
Get-UsagesByAccountId-AccountId $AccountId
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UsagesByAccountId"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/manual-discover-applications-template:
|
|
get:
|
|
summary: Download CSV Template for Discovery
|
|
tags:
|
|
- Application Discovery
|
|
description: |
|
|
Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values 'Example Application' and 'Example Description'.
|
|
|
|
The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint.
|
|
security:
|
|
- userAuth:
|
|
- idn:application-discovery:read
|
|
operationId: getManualDiscoverApplicationsCsvTemplate
|
|
responses:
|
|
'200':
|
|
description: A CSV file download was successful.
|
|
content:
|
|
text/csv:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
application_name:
|
|
type: string
|
|
description: Name of the application.
|
|
example: Example Application
|
|
description:
|
|
type: string
|
|
description: Description of the application.
|
|
example: Example Description
|
|
example: |
|
|
application_name,description
|
|
Example Application,Example Description
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
|
|
# Download CSV Template for Discovery
|
|
|
|
try {
|
|
Get-ManualDiscoverApplicationsCsvTemplate
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-ManualDiscoverApplicationsCsvTemplate
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManualDiscoverApplicationsCsvTemplate"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/manual-discover-applications:
|
|
post:
|
|
summary: Upload CSV to Discover Applications
|
|
tags:
|
|
- Application Discovery
|
|
description: |-
|
|
Uploading a CSV file with application data for manual correlation to specific ISC connectors.
|
|
If a suitable ISC connector is unavailable, the system will recommend generic connectors instead.
|
|
security:
|
|
- userAuth:
|
|
- idn:application-discovery:write
|
|
operationId: sendManualDiscoverApplicationsCsvTemplate
|
|
requestBody:
|
|
content:
|
|
multipart/form-data:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
file:
|
|
type: string
|
|
format: binary
|
|
description: The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered.
|
|
example: |-
|
|
application_name,description
|
|
"Sample App","This is a sample description for Sample App."
|
|
"Another App","Description for Another App."
|
|
required:
|
|
- file
|
|
responses:
|
|
'200':
|
|
description: The CSV has been successfully processed.
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$File = # System.IO.FileInfo | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered.
|
|
|
|
# Upload CSV to Discover Applications
|
|
|
|
try {
|
|
Send-ManualDiscoverApplicationsCsvTemplate-File $File
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Send-ManualDiscoverApplicationsCsvTemplate -File $File
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ManualDiscoverApplicationsCsvTemplate"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/discovered-applications:
|
|
get:
|
|
operationId: getDiscoveredApplications
|
|
tags:
|
|
- Application Discovery
|
|
summary: Get Discovered Applications for Tenant
|
|
description: |
|
|
Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors.
|
|
security:
|
|
- userAuth:
|
|
- idn:application-discovery:read
|
|
parameters:
|
|
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml
|
|
- $ref: '#/paths/~1access-profiles/get/parameters/2'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
|
|
- in: query
|
|
name: detail
|
|
schema:
|
|
type: string
|
|
enum:
|
|
- SLIM
|
|
- FULL
|
|
description: Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior.
|
|
example: FULL
|
|
- in: query
|
|
name: filter
|
|
schema:
|
|
type: string
|
|
description: |
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
**name**: *eq, sw, co*
|
|
|
|
**description**: *eq, sw, co*
|
|
|
|
**createdAtStart**: *eq, le, ge*
|
|
|
|
**createdAtEnd**: *eq, le, ge*
|
|
|
|
**discoveredAtStart**: *eq, le, ge*
|
|
|
|
**discoveredAtEnd**: *eq, le, ge*
|
|
|
|
**discoverySource**: *eq, in*
|
|
example: name eq "Okta" and description co "Okta" and discoverySource in ("csv", "Okta Saas")
|
|
required: false
|
|
style: form
|
|
- in: query
|
|
name: sorters
|
|
schema:
|
|
type: string
|
|
format: comma-separated
|
|
description: |-
|
|
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
|
|
|
Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource**
|
|
example: name
|
|
responses:
|
|
'200':
|
|
description: List of discovered applications. By default, the API returns a list of SLIM discovered applications.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
oneOf:
|
|
- type: object
|
|
description: Discovered applications
|
|
title: Slim Discovered Application
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
description: Unique identifier for the discovered application.
|
|
example: 2d9180835d2e5168015d32f890ca1581
|
|
name:
|
|
type: string
|
|
description: Name of the discovered application.
|
|
example: ExampleApp
|
|
discoverySource:
|
|
type: string
|
|
description: Source from which the application was discovered.
|
|
example: csv
|
|
discoveredVendor:
|
|
type: string
|
|
description: The vendor associated with the discovered application.
|
|
example: ExampleVendor
|
|
description:
|
|
type: string
|
|
description: A brief description of the discovered application.
|
|
example: An application for managing examples.
|
|
recommendedConnectors:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: List of recommended connectors for the application.
|
|
example:
|
|
- ConnectorA
|
|
- ConnectorB
|
|
discoveredAt:
|
|
type: string
|
|
format: date-time
|
|
description: The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format.
|
|
example: '2023-01-01T12:00:00Z'
|
|
createdAt:
|
|
type: string
|
|
format: date-time
|
|
description: The timestamp when the application was first discovered, in ISO 8601 format.
|
|
example: '2023-01-01T12:00:00Z'
|
|
status:
|
|
type: string
|
|
description: |-
|
|
The status of an application within the discovery source.
|
|
|
|
By default this field is set to "ACTIVE" when the application is discovered.
|
|
|
|
If an application has been deleted from within the discovery source, the status will be set to "INACTIVE".
|
|
example: ACTIVE
|
|
- type: object
|
|
description: Discovered applications with their respective associated sources
|
|
title: Discovered Application
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uuid
|
|
description: Unique identifier for the discovered application.
|
|
example: 2d9180835d2e5168015d32f890ca1581
|
|
name:
|
|
type: string
|
|
description: Name of the discovered application.
|
|
example: ExampleApp
|
|
discoverySource:
|
|
type: string
|
|
description: Source from which the application was discovered.
|
|
example: csv
|
|
discoveredVendor:
|
|
type: string
|
|
description: The vendor associated with the discovered application.
|
|
example: ExampleVendor
|
|
description:
|
|
type: string
|
|
description: A brief description of the discovered application.
|
|
example: An application for managing examples.
|
|
recommendedConnectors:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: List of recommended connectors for the application.
|
|
example:
|
|
- ConnectorA
|
|
- ConnectorB
|
|
discoveredAt:
|
|
type: string
|
|
format: date-time
|
|
description: The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format.
|
|
example: '2023-01-01T12:00:00Z'
|
|
createdAt:
|
|
type: string
|
|
format: date-time
|
|
description: The timestamp when the application was first discovered, in ISO 8601 format.
|
|
example: '2023-01-01T12:00:00Z'
|
|
status:
|
|
type: string
|
|
description: |-
|
|
The status of an application within the discovery source.
|
|
|
|
By default this field is set to "ACTIVE" when the application is discovered.
|
|
|
|
If an application has been deleted from within the discovery source, the status will be set to "INACTIVE".
|
|
example: ACTIVE
|
|
associatedSources:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
description: List of associated sources related to this discovered application.
|
|
example:
|
|
- e0cc5d7d-bf7f-4f81-b2af-8885b09d9923
|
|
- a0303682-5e4a-44f7-bdc2-6ce6112549c1
|
|
examples:
|
|
Slim Discovered Application:
|
|
description: List of discovered applications
|
|
value:
|
|
- id: 09d88a67-bae8-422c-a09b-f7a72f5ab032
|
|
name: Example App
|
|
discoverySource: csv
|
|
discoveredVendor: Example Vendor
|
|
description: An application for managing examples.
|
|
recommendedConnectors:
|
|
- ConnectorA
|
|
- ConnectorB
|
|
discoveredAt: '2023-07-01T12:00:00Z'
|
|
createdAt: '2024-06-01T12:00:00Z'
|
|
status: ACTIVE
|
|
- id: 59310a1e-0d8f-42fa-95aa-b82b263de7f6
|
|
name: Sample Tracker
|
|
discoverySource: Okta SaaS
|
|
discoveredVendor: Sample Vendor
|
|
description: A tool for monitoring and managing samples.
|
|
recommendedConnectors:
|
|
- ConnectorC
|
|
- ConnectorD
|
|
discoveredAt: '2023-08-15T08:00:00Z'
|
|
createdAt: '2024-05-20T08:00:00Z'
|
|
status: ACTIVE
|
|
- id: dfe675cb-f689-475f-99f1-49e348449867
|
|
name: Demo Manager
|
|
discoverySource: Okta SaaS
|
|
discoveredVendor: Demo Provider
|
|
description: Software to demonstrate basic functionalities.
|
|
recommendedConnectors:
|
|
- ConnectorE
|
|
- ConnectorF
|
|
discoveredAt: '2023-09-10T15:00:00Z'
|
|
createdAt: '2024-07-03T15:00:00Z'
|
|
status: ACTIVE
|
|
Discovered Application:
|
|
description: List of discovered applications with their respective associated sources
|
|
value:
|
|
- id: 6f672248-2dac-4cf5-9531-fca0719cbb4a
|
|
name: Example App
|
|
discoverySource: csv
|
|
discoveredVendor: Example Vendor
|
|
description: An application for managing examples.
|
|
recommendedConnectors:
|
|
- ConnectorA
|
|
- ConnectorB
|
|
discoveredAt: '2023-07-01T12:00:00Z'
|
|
createdAt: '2024-06-01T12:00:00Z'
|
|
status: ACTIVE
|
|
associatedSources:
|
|
- e0cc5d7d-bf7f-4f81-b2af-8885b09d9923
|
|
- id: b3a3a704-6a45-45ee-a501-bbc332388222
|
|
name: Sample Tracker
|
|
discoverySource: Okta SaaS
|
|
discoveredVendor: Sample Vendor
|
|
description: A tool for monitoring and managing samples.
|
|
recommendedConnectors:
|
|
- ConnectorC
|
|
- ConnectorD
|
|
discoveredAt: '2023-08-15T08:00:00Z'
|
|
createdAt: '2024-05-20T08:00:00Z'
|
|
status: ACTIVE
|
|
associatedSources:
|
|
- a3b159f2-5f09-43c9-b40e-a6f317aa5b8f
|
|
- e0cc5d7d-bf7f-4f81-b2af-8885b09d9923
|
|
- id: 1d070458-faed-4a6c-8990-918ad70a06ee
|
|
name: Demo Manager
|
|
discoverySource: Okta SaaS
|
|
discoveredVendor: Demo Provider
|
|
description: Software to demonstrate basic functionalities.
|
|
recommendedConnectors:
|
|
- ConnectorE
|
|
- ConnectorF
|
|
discoveredAt: '2023-09-10T15:00:00Z'
|
|
createdAt: '2024-07-03T15:00:00Z'
|
|
status: ACTIVE
|
|
associatedSources:
|
|
- 4e2d7605-833f-4c34-8d03-5b2c7d2f4f66
|
|
- f9b7e2ce-aced-4117-a95f-4ffad8b33989
|
|
- a3b159f2-5f09-43c9-b40e-a6f317aa5b8f
|
|
- id: 9be7c5a5-9f37-46ba-965a-e5b9453472c6
|
|
name: Task Organizer
|
|
discoverySource: Manual Entry
|
|
discoveredVendor: Organizer Solutions
|
|
description: An application designed to help teams manage tasks and projects efficiently.
|
|
recommendedConnectors:
|
|
- ConnectorG
|
|
- ConnectorH
|
|
discoveredAt: '2023-10-05T14:00:00Z'
|
|
createdAt: '2024-08-01T14:00:00Z'
|
|
status: ACTIVE
|
|
associatedSources: []
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
|
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
|
$Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional)
|
|
$Filter = "name eq "Okta" and description co "Okta" and discoverySource in ("csv", "Okta Saas")" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional)
|
|
$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource** (optional)
|
|
|
|
# Get Discovered Applications for Tenant
|
|
|
|
try {
|
|
Get-DiscoveredApplications
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-DiscoveredApplications -Limit $Limit -Offset $Offset -Detail $Detail -Filter $Filter -Sorters $Sorters
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-DiscoveredApplications"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
/vendor-connector-mappings:
|
|
get:
|
|
security:
|
|
- userAuth:
|
|
- idn:application-discovery:read
|
|
operationId: getVendorConnectorMappings
|
|
tags:
|
|
- Vendor Connector Mappings
|
|
summary: List Vendor Connector Mappings
|
|
description: |
|
|
Get a list of mappings between SaaS vendors and ISC connectors, detailing the connections established for correlation.
|
|
responses:
|
|
'200':
|
|
description: Successfully retrieved list.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The unique identifier for the vendor-connector mapping.
|
|
example: 78733556-9ea3-4f59-bf69-e5cd92b011b4
|
|
vendor:
|
|
type: string
|
|
description: The name of the vendor.
|
|
example: Example vendor
|
|
connector:
|
|
type: string
|
|
description: The name of the connector.
|
|
example: Example connector
|
|
createdAt:
|
|
type: string
|
|
format: date-time
|
|
description: The creation timestamp of the mapping.
|
|
example: '2024-03-13T12:56:19.391294Z'
|
|
createdBy:
|
|
type: string
|
|
description: The identifier of the user who created the mapping.
|
|
example: admin
|
|
updatedAt:
|
|
type: object
|
|
nullable: true
|
|
properties:
|
|
Time:
|
|
type: string
|
|
format: date-time
|
|
description: The timestamp when the mapping was last updated, represented in ISO 8601 format.
|
|
example: '2024-03-14T12:56:19.391294Z'
|
|
Valid:
|
|
type: boolean
|
|
description: A flag indicating if the 'Time' field is set and valid.
|
|
default: false
|
|
example: true
|
|
description: An object representing the nullable timestamp of the last update.
|
|
updatedBy:
|
|
type: object
|
|
nullable: true
|
|
properties:
|
|
String:
|
|
type: string
|
|
description: The identifier of the user who last updated the mapping, if available.
|
|
example: user-67891
|
|
Valid:
|
|
type: boolean
|
|
description: A flag indicating if the 'String' field is set and valid.
|
|
default: false
|
|
example: true
|
|
description: An object representing the nullable identifier of the user who last updated the mapping.
|
|
deletedAt:
|
|
type: object
|
|
nullable: true
|
|
properties:
|
|
Time:
|
|
type: string
|
|
format: date-time
|
|
description: The timestamp when the mapping was deleted, represented in ISO 8601 format, if applicable.
|
|
example: '0001-01-01T00:00:00Z'
|
|
Valid:
|
|
type: boolean
|
|
description: A flag indicating if the 'Time' field is set and valid, i.e., if the mapping has been deleted.
|
|
default: false
|
|
example: false
|
|
description: An object representing the nullable timestamp of when the mapping was deleted.
|
|
deletedBy:
|
|
type: object
|
|
nullable: true
|
|
properties:
|
|
String:
|
|
type: string
|
|
description: The identifier of the user who deleted the mapping, if applicable.
|
|
example: ''
|
|
Valid:
|
|
type: boolean
|
|
description: A flag indicating if the 'String' field is set and valid, i.e., if the mapping has been deleted.
|
|
default: false
|
|
example: false
|
|
description: An object representing the nullable identifier of the user who deleted the mapping.
|
|
example:
|
|
- id: 78733556-9ea3-4f59-bf69-e5cd92b011b4
|
|
vendor: Example Vendor
|
|
connector: Example Connector
|
|
createdAt: '2024-03-13T12:56:19.391294Z'
|
|
createdBy: admin
|
|
updatedAt:
|
|
Time: '2024-03-14T12:56:19.391294Z'
|
|
Valid: true
|
|
updatedBy:
|
|
String: user-67891
|
|
Valid: true
|
|
deletedAt:
|
|
Time: '0001-01-01T00:00:00Z'
|
|
Valid: false
|
|
deletedBy:
|
|
String: ''
|
|
Valid: false
|
|
- id: 78733556-9ea3-4f59-bf69-e5cd92b011b5
|
|
vendor: Another Corporation
|
|
connector: Another Connector
|
|
createdAt: '2024-04-13T11:46:19.391294Z'
|
|
createdBy: admin
|
|
updatedAt:
|
|
Time: '0001-01-01T00:00:00Z'
|
|
Valid: false
|
|
updatedBy:
|
|
String: ''
|
|
Valid: false
|
|
deletedAt:
|
|
Time: '0001-01-01T00:00:00Z'
|
|
Valid: false
|
|
deletedBy:
|
|
String: ''
|
|
Valid: false
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'405':
|
|
description: Method Not Allowed - indicates that the server knows the request method, but the target resource doesn't support this method.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
errorName:
|
|
description: A message describing the error
|
|
example: NotSupportedException
|
|
errorMessage:
|
|
description: Description of the error
|
|
example: Cannot consume content type
|
|
trackingId:
|
|
type: string
|
|
description: Unique tracking id for the error.
|
|
example: e7eab60924f64aa284175b9fa3309599
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
|
|
# List Vendor Connector Mappings
|
|
|
|
try {
|
|
Get-VendorConnectorMappings
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Get-VendorConnectorMappings
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-VendorConnectorMappings"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
post:
|
|
security:
|
|
- userAuth:
|
|
- idn:application-discovery:write
|
|
operationId: createVendorConnectorMapping
|
|
tags:
|
|
- Vendor Connector Mappings
|
|
summary: Create Vendor Connector Mapping
|
|
description: |
|
|
Create a new mapping between a SaaS vendor and an ISC connector to establish correlation paths.
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1vendor-connector-mappings/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/beta/schemas/VendorConnectorMapping.yaml
|
|
responses:
|
|
'200':
|
|
description: Successfully created a new vendor connector mapping.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1vendor-connector-mappings/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/beta/schemas/VendorConnectorMapping.yaml
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'405':
|
|
$ref: '#/paths/~1vendor-connector-mappings/get/responses/405'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/405.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$VendorConnectorMapping = @"
|
|
{
|
|
"createdAt" : "2024-03-13T12:56:19.391294Z",
|
|
"deletedAt" : {
|
|
"Valid" : false,
|
|
"Time" : "0001-01-01T00:00:00Z"
|
|
},
|
|
"updatedBy" : {
|
|
"Valid" : true,
|
|
"String" : "user-67891"
|
|
},
|
|
"connector" : "Example connector",
|
|
"createdBy" : "admin",
|
|
"vendor" : "Example vendor",
|
|
"id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4",
|
|
"deletedBy" : {
|
|
"Valid" : false,
|
|
"String" : ""
|
|
},
|
|
"updatedAt" : {
|
|
"Valid" : true,
|
|
"Time" : "2024-03-14T12:56:19.391294Z"
|
|
}
|
|
}
|
|
"@
|
|
|
|
# Create Vendor Connector Mapping
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping
|
|
New-VendorConnectorMapping-VendorConnectorMapping $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# New-VendorConnectorMapping -VendorConnectorMapping $VendorConnectorMapping
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-VendorConnectorMapping"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
delete:
|
|
security:
|
|
- userAuth:
|
|
- idn:application-discovery:write
|
|
operationId: deleteVendorConnectorMapping
|
|
tags:
|
|
- Vendor Connector Mappings
|
|
summary: Delete Vendor Connector Mapping
|
|
description: |
|
|
Soft delete a mapping between a SaaS vendor and an ISC connector, removing the established correlation.
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/paths/~1vendor-connector-mappings/get/responses/200/content/application~1json/schema/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/beta/schemas/VendorConnectorMapping.yaml
|
|
responses:
|
|
'200':
|
|
description: Successfully deleted the specified vendor connector mapping.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
description: The number of vendor connector mappings successfully deleted.
|
|
example: 1
|
|
'400':
|
|
$ref: '#/paths/~1access-profiles/get/responses/400'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
|
|
'401':
|
|
$ref: '#/paths/~1access-profiles/get/responses/401'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
|
|
'403':
|
|
$ref: '#/paths/~1access-profiles/get/responses/403'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
|
|
'404':
|
|
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
|
|
'429':
|
|
$ref: '#/paths/~1access-profiles/get/responses/429'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
|
|
'500':
|
|
$ref: '#/paths/~1access-profiles/get/responses/500'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
|
|
x-codeSamples:
|
|
- lang: PowerShell
|
|
label: SDK
|
|
source: |
|
|
$VendorConnectorMapping = @"
|
|
{
|
|
"createdAt" : "2024-03-13T12:56:19.391294Z",
|
|
"deletedAt" : {
|
|
"Valid" : false,
|
|
"Time" : "0001-01-01T00:00:00Z"
|
|
},
|
|
"updatedBy" : {
|
|
"Valid" : true,
|
|
"String" : "user-67891"
|
|
},
|
|
"connector" : "Example connector",
|
|
"createdBy" : "admin",
|
|
"vendor" : "Example vendor",
|
|
"id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4",
|
|
"deletedBy" : {
|
|
"Valid" : false,
|
|
"String" : ""
|
|
},
|
|
"updatedAt" : {
|
|
"Valid" : true,
|
|
"Time" : "2024-03-14T12:56:19.391294Z"
|
|
}
|
|
}
|
|
"@
|
|
|
|
# Delete Vendor Connector Mapping
|
|
|
|
try {
|
|
$Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping
|
|
Remove-VendorConnectorMapping-VendorConnectorMapping $Result
|
|
|
|
# Below is a request that includes all optional parameters
|
|
# Remove-VendorConnectorMapping -VendorConnectorMapping $VendorConnectorMapping
|
|
} catch {
|
|
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-VendorConnectorMapping"
|
|
Write-Host $_.ErrorDetails
|
|
}
|
|
security:
|
|
- userAuth:
|
|
- sp:scopes:all
|
|
components:
|
|
securitySchemes:
|
|
userAuth:
|
|
type: oauth2
|
|
x-displayName: Personal Access Token
|
|
description: |
|
|
OAuth2 Bearer token (JWT) generated using either a [personal access token (PAT)](https://developer.sailpoint.com/docs/api/authentication/#generate-a-personal-access-token) or through the [authorization code flow](https://developer.sailpoint.com/docs/api/authentication/#request-access-token-with-authorization-code-grant-flow).
|
|
|
|
Personal access tokens are associated with a user in Identity Security Cloud and relies on the user's [user level](https://documentation.sailpoint.com/saas/help/common/users/index.html) (ex. Admin, Helpdesk, etc.) to determine a base level of access.
|
|
|
|
See [Identity Security Cloud REST API Authentication](https://developer.sailpoint.com/docs/api/authentication/) for more information.
|
|
flows:
|
|
clientCredentials:
|
|
tokenUrl: https://tenant.api.identitynow.com/oauth/token
|
|
scopes:
|
|
sp:scopes:default: default scope
|
|
sp:scopes:all: access to all scopes
|
|
authorizationCode:
|
|
authorizationUrl: https://tenant.login.sailpoint.com/oauth/authorize
|
|
tokenUrl: https://tenant.api.identitynow.com/oauth/token
|
|
scopes:
|
|
sp:scopes:default: default scope
|
|
sp:scopes:all: access to all scopes
|
|
applicationAuth:
|
|
type: oauth2
|
|
x-displayName: Client Credentials
|
|
description: |
|
|
OAuth2 Bearer token (JWT) generated using [client credentials flow](https://developer.sailpoint.com/docs/api/authentication/#request-access-token-with-client-credentials-grant-flow).
|
|
|
|
Client credentials refers to tokens that are not associated with a user in Identity Security Cloud.
|
|
|
|
See [Identity Security Cloud REST API Authentication](https://developer.sailpoint.com/docs/api/authentication/) for more information.
|
|
flows:
|
|
clientCredentials:
|
|
tokenUrl: https://tenant.api.identitynow.com/oauth/token
|
|
scopes:
|
|
sp:scopes:default: default scope
|
|
sp:scopes:all: access to all scopes
|
|
schemas:
|
|
AccessRequest:
|
|
type: object
|
|
properties:
|
|
requestedFor:
|
|
description: A list of Identity IDs for whom the Access is requested. If it's a Revoke request, there can only be one Identity ID.
|
|
type: array
|
|
items:
|
|
type: string
|
|
example: 2c918084660f45d6016617daa9210584
|
|
requestType:
|
|
type: string
|
|
enum:
|
|
- GRANT_ACCESS
|
|
- REVOKE_ACCESS
|
|
- null
|
|
description: Access request type. Defaults to GRANT_ACCESS. REVOKE_ACCESS type can only have a single Identity ID in the requestedFor field.
|
|
example: GRANT_ACCESS
|
|
nullable: true
|
|
requestedItems:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
enum:
|
|
- ACCESS_PROFILE
|
|
- ROLE
|
|
- ENTITLEMENT
|
|
description: The type of the item being requested.
|
|
example: ACCESS_PROFILE
|
|
id:
|
|
type: string
|
|
description: ID of Role, Access Profile or Entitlement being requested.
|
|
example: 2c9180835d2e5168015d32f890ca1581
|
|
comment:
|
|
type: string
|
|
description: |
|
|
Comment provided by requester.
|
|
* Comment is required when the request is of type Revoke Access.
|
|
example: Requesting access profile for John Doe
|
|
clientMetadata:
|
|
type: object
|
|
additionalProperties:
|
|
type: string
|
|
example:
|
|
requestedAppId: 2c91808f7892918f0178b78da4a305a1
|
|
requestedAppName: test-app
|
|
example:
|
|
requestedAppName: test-app
|
|
requestedAppId: 2c91808f7892918f0178b78da4a305a1
|
|
description: Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status.
|
|
removeDate:
|
|
type: string
|
|
description: |
|
|
The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date.
|
|
* Specify a date in the future.
|
|
* The current SLA for the deprovisioning is 24 hours.
|
|
* This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration.
|
|
format: date-time
|
|
example: '2020-07-11T21:23:15.000Z'
|
|
required:
|
|
- id
|
|
- type
|
|
minItems: 1
|
|
maxItems: 25
|
|
clientMetadata:
|
|
type: object
|
|
additionalProperties:
|
|
type: string
|
|
example:
|
|
requestedAppId: 2c91808f7892918f0178b78da4a305a1
|
|
requestedAppName: test-app
|
|
example:
|
|
requestedAppId: 2c91808f7892918f0178b78da4a305a1
|
|
requestedAppName: test-app
|
|
description: Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities.
|
|
required:
|
|
- requestedFor
|
|
- requestedItems
|
|
AccessRequestItem:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
enum:
|
|
- ACCESS_PROFILE
|
|
- ROLE
|
|
- ENTITLEMENT
|
|
description: The type of the item being requested.
|
|
example: ACCESS_PROFILE
|
|
id:
|
|
type: string
|
|
description: ID of Role, Access Profile or Entitlement being requested.
|
|
example: 2c9180835d2e5168015d32f890ca1581
|
|
comment:
|
|
type: string
|
|
description: |
|
|
Comment provided by requester.
|
|
* Comment is required when the request is of type Revoke Access.
|
|
example: Requesting access profile for John Doe
|
|
clientMetadata:
|
|
type: object
|
|
additionalProperties:
|
|
type: string
|
|
example:
|
|
requestedAppId: 2c91808f7892918f0178b78da4a305a1
|
|
requestedAppName: test-app
|
|
example:
|
|
requestedAppName: test-app
|
|
requestedAppId: 2c91808f7892918f0178b78da4a305a1
|
|
description: Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status.
|
|
removeDate:
|
|
type: string
|
|
description: |
|
|
The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date.
|
|
* Specify a date in the future.
|
|
* The current SLA for the deprovisioning is 24 hours.
|
|
* This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration.
|
|
format: date-time
|
|
example: '2020-07-11T21:23:15.000Z'
|
|
required:
|
|
- id
|
|
- type
|
|
AccessProfileDocument:
|
|
description: 'More complete representation of an access profile. '
|
|
allOf:
|
|
- allOf:
|
|
- $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/source'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/Reference.yaml
|
|
- type: object
|
|
properties:
|
|
description:
|
|
type: string
|
|
description: Access item's description.
|
|
example: The admin role
|
|
created:
|
|
type: string
|
|
description: ISO-8601 date-time referring to the time when the object was created.
|
|
nullable: true
|
|
format: date-time
|
|
example: '2018-06-25T20:22:28.104Z'
|
|
modified:
|
|
type: string
|
|
description: ISO-8601 date-time referring to the time when the object was last modified.
|
|
nullable: true
|
|
format: date-time
|
|
example: '2018-06-25T20:22:28.104Z'
|
|
synced:
|
|
type: string
|
|
description: |-
|
|
ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API.
|
|
This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database.
|
|
There may be some delay between the `synced` time and the time when the updated data is actually available in the search API.
|
|
nullable: true
|
|
format: date-time
|
|
example: '2018-06-25T20:22:33.104Z'
|
|
enabled:
|
|
type: boolean
|
|
description: Indicates whether the access item is currently enabled.
|
|
default: false
|
|
example: true
|
|
requestable:
|
|
type: boolean
|
|
description: Indicates whether the access item can be requested.
|
|
default: true
|
|
example: true
|
|
requestCommentsRequired:
|
|
type: boolean
|
|
description: Indicates whether comments are required for requests to access the item.
|
|
default: false
|
|
example: false
|
|
owner:
|
|
type: object
|
|
description: Owner's identity.
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: Owner's DTO type.
|
|
enum:
|
|
- IDENTITY
|
|
example: IDENTITY
|
|
id:
|
|
type: string
|
|
description: Owner's identity ID.
|
|
example: 2c9180a46faadee4016fb4e018c20639
|
|
name:
|
|
type: string
|
|
description: Owner's display name.
|
|
example: Support
|
|
email:
|
|
type: string
|
|
description: Owner's email.
|
|
example: cloud-support@sailpoint.com
|
|
- type: object
|
|
required:
|
|
- id
|
|
- name
|
|
- _type
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: Access profile's ID.
|
|
example: 2c9180825a6c1adc015a71c9023f0818
|
|
name:
|
|
type: string
|
|
description: Access profile's name.
|
|
example: Cloud Eng
|
|
_type:
|
|
description: |-
|
|
Access profile's document type.
|
|
This enum represents the currently supported document types.
|
|
Additional values may be added in the future without notice.
|
|
type: string
|
|
enum:
|
|
- accessprofile
|
|
- accountactivity
|
|
- account
|
|
- aggregation
|
|
- entitlement
|
|
- event
|
|
- identity
|
|
- role
|
|
example: accessprofile
|
|
source:
|
|
type: object
|
|
description: Access profile's source.
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: Source's ID.
|
|
example: ff8081815757d4fb0157588f3d9d008f
|
|
name:
|
|
type: string
|
|
description: Source's name.
|
|
example: Employees
|
|
entitlements:
|
|
type: array
|
|
description: Entitlements the access profile has access to.
|
|
items:
|
|
type: object
|
|
properties:
|
|
hasPermissions:
|
|
type: boolean
|
|
description: Indicates whether the entitlement has permissions.
|
|
default: false
|
|
example: false
|
|
description:
|
|
type: string
|
|
description: Entitlement's description.
|
|
example: Cloud engineering
|
|
attribute:
|
|
type: string
|
|
description: Entitlement attribute's name.
|
|
example: memberOf
|
|
value:
|
|
type: string
|
|
description: Entitlement's value.
|
|
example: CN=Cloud Engineering,DC=sailpoint,DC=COM
|
|
schema:
|
|
type: string
|
|
description: Entitlement's schema.
|
|
example: group
|
|
privileged:
|
|
type: boolean
|
|
description: Indicates whether the entitlement is privileged.
|
|
default: false
|
|
example: false
|
|
id:
|
|
type: string
|
|
description: Entitlement's ID.
|
|
example: 2c918084575812550157589064f33b89
|
|
name:
|
|
type: string
|
|
description: Entitlement's name.
|
|
example: CN=Cloud Engineering,DC=sailpoint,DC=COM
|
|
entitlementCount:
|
|
type: integer
|
|
description: Number of entitlements.
|
|
example: 5
|
|
tags:
|
|
type: array
|
|
description: Tags that have been applied to the object.
|
|
items:
|
|
type: string
|
|
example:
|
|
- TAG_1
|
|
- TAG_2
|
|
AccessProfileSummary:
|
|
description: This is a summary representation of an access profile.
|
|
allOf:
|
|
- allOf:
|
|
- $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/owner'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/DisplayReference.yaml
|
|
- type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
enum:
|
|
- ACCOUNT_CORRELATION_CONFIG
|
|
- ACCESS_PROFILE
|
|
- ACCESS_REQUEST_APPROVAL
|
|
- ACCOUNT
|
|
- APPLICATION
|
|
- CAMPAIGN
|
|
- CAMPAIGN_FILTER
|
|
- CERTIFICATION
|
|
- CLUSTER
|
|
- CONNECTOR_SCHEMA
|
|
- ENTITLEMENT
|
|
- GOVERNANCE_GROUP
|
|
- IDENTITY
|
|
- IDENTITY_PROFILE
|
|
- IDENTITY_REQUEST
|
|
- MACHINE_IDENTITY
|
|
- LIFECYCLE_STATE
|
|
- PASSWORD_POLICY
|
|
- ROLE
|
|
- RULE
|
|
- SOD_POLICY
|
|
- SOURCE
|
|
- TAG
|
|
- TAG_CATEGORY
|
|
- TASK_RESULT
|
|
- REPORT_RESULT
|
|
- SOD_VIOLATION
|
|
- ACCOUNT_ACTIVITY
|
|
- WORKGROUP
|
|
description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure.
|
|
example: IDENTITY
|
|
description:
|
|
type: string
|
|
nullable: true
|
|
example: null
|
|
- type: object
|
|
properties:
|
|
source:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
example: 2c91808568c529c60168cca6f90c1313
|
|
description: The unique ID of the referenced object.
|
|
name:
|
|
type: string
|
|
example: John Doe
|
|
description: The human readable name of the referenced object.
|
|
owner:
|
|
allOf:
|
|
- $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/source'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/Reference.yaml
|
|
- type: object
|
|
properties:
|
|
displayName:
|
|
type: string
|
|
example: John Q. Doe
|
|
revocable:
|
|
type: boolean
|
|
example: true
|
|
AccessReviewReassignment:
|
|
type: object
|
|
properties:
|
|
reassign:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The ID of item or identity being reassigned.
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
type:
|
|
type: string
|
|
description: The type of item or identity being reassigned.
|
|
enum:
|
|
- TARGET_SUMMARY
|
|
- ITEM
|
|
- IDENTITY_SUMMARY
|
|
example: ITEM
|
|
required:
|
|
- id
|
|
- type
|
|
reassignTo:
|
|
type: string
|
|
description: The ID of the identity to which the certification is reassigned
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
reason:
|
|
type: string
|
|
description: The reason comment for why the reassign was made
|
|
example: reassigned for some reason
|
|
required:
|
|
- reassign
|
|
- reassignTo
|
|
- reason
|
|
Account:
|
|
allOf:
|
|
- type: object
|
|
required:
|
|
- name
|
|
properties:
|
|
id:
|
|
description: System-generated unique ID of the Object
|
|
type: string
|
|
example: id12345
|
|
readOnly: true
|
|
name:
|
|
description: Name of the Object
|
|
type: string
|
|
example: aName
|
|
created:
|
|
description: Creation date of the Object
|
|
type: string
|
|
example: '2015-05-28T14:07:17Z'
|
|
format: date-time
|
|
readOnly: true
|
|
modified:
|
|
description: Last modification date of the Object
|
|
type: string
|
|
example: '2015-05-28T14:07:17Z'
|
|
format: date-time
|
|
readOnly: true
|
|
- type: object
|
|
required:
|
|
- sourceId
|
|
- sourceName
|
|
- attributes
|
|
- authoritative
|
|
- disabled
|
|
- locked
|
|
- nativeIdentity
|
|
- systemAccount
|
|
- uncorrelated
|
|
- manuallyCorrelated
|
|
- hasEntitlements
|
|
properties:
|
|
sourceId:
|
|
type: string
|
|
example: 2c9180835d2e5168015d32f890ca1581
|
|
description: The unique ID of the source this account belongs to
|
|
sourceName:
|
|
type: string
|
|
nullable: true
|
|
example: Employees
|
|
description: The display name of the source this account belongs to
|
|
identityId:
|
|
type: string
|
|
example: 2c9180835d2e5168015d32f890ca1581
|
|
description: The unique ID of the identity this account is correlated to
|
|
cloudLifecycleState:
|
|
type: string
|
|
nullable: true
|
|
example: active
|
|
description: The lifecycle state of the identity this account is correlated to
|
|
identityState:
|
|
type: string
|
|
nullable: true
|
|
example: ACTIVE
|
|
description: The identity state of the identity this account is correlated to
|
|
connectionType:
|
|
type: string
|
|
nullable: true
|
|
example: direct
|
|
description: The connection type of the source this account is from
|
|
isMachine:
|
|
type: boolean
|
|
default: false
|
|
description: Indicates if the account is of machine type
|
|
example: true
|
|
recommendation:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
enum:
|
|
- HUMAN
|
|
- MACHINE
|
|
description: Recommended type of account.
|
|
example: MACHINE
|
|
method:
|
|
type: string
|
|
enum:
|
|
- DISCOVERY
|
|
- SOURCE
|
|
- CRITERIA
|
|
description: Method used to produce the recommendation. DISCOVERY - suggested by AI, SOURCE - the account comes from a source flagged as containing machine accounts, CRITERIA - the account satisfies classification criteria.
|
|
example: DISCOVERY
|
|
required:
|
|
- type
|
|
- method
|
|
attributes:
|
|
type: object
|
|
nullable: true
|
|
additionalProperties: true
|
|
description: The account attributes that are aggregated
|
|
example:
|
|
firstName: SailPoint
|
|
lastName: Support
|
|
displayName: SailPoint Support
|
|
authoritative:
|
|
type: boolean
|
|
description: Indicates if this account is from an authoritative source
|
|
example: false
|
|
description:
|
|
type: string
|
|
description: A description of the account
|
|
nullable: true
|
|
example: null
|
|
disabled:
|
|
type: boolean
|
|
description: Indicates if the account is currently disabled
|
|
example: false
|
|
locked:
|
|
type: boolean
|
|
description: Indicates if the account is currently locked
|
|
example: false
|
|
nativeIdentity:
|
|
type: string
|
|
description: The unique ID of the account generated by the source system
|
|
example: '552775'
|
|
systemAccount:
|
|
type: boolean
|
|
example: false
|
|
description: If true, this is a user account within IdentityNow. If false, this is an account from a source system.
|
|
uncorrelated:
|
|
type: boolean
|
|
description: Indicates if this account is not correlated to an identity
|
|
example: false
|
|
uuid:
|
|
type: string
|
|
description: The unique ID of the account as determined by the account schema
|
|
example: '{b0dce506-d6d4-44d2-8a32-d9a5b21fb175}'
|
|
nullable: true
|
|
manuallyCorrelated:
|
|
type: boolean
|
|
description: Indicates if the account has been manually correlated to an identity
|
|
example: false
|
|
hasEntitlements:
|
|
type: boolean
|
|
description: Indicates if the account has entitlements
|
|
example: true
|
|
identity:
|
|
type: object
|
|
properties:
|
|
type:
|
|
$ref: '#/components/schemas/AccessProfileSummary/allOf/0/allOf/1/properties/type'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/DtoType.yaml
|
|
id:
|
|
type: string
|
|
description: ID of the object to which this reference applies
|
|
example: 2c91808568c529c60168cca6f90c1313
|
|
name:
|
|
type: string
|
|
description: Human-readable display name of the object to which this reference applies
|
|
example: William Wilson
|
|
sourceOwner:
|
|
$ref: '#/components/schemas/Account/allOf/1/properties/identity'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/BaseReferenceDto.yaml
|
|
features:
|
|
type: string
|
|
description: A string list containing the owning source's features
|
|
example: ENABLE
|
|
nullable: true
|
|
origin:
|
|
type: string
|
|
nullable: true
|
|
enum:
|
|
- AGGREGATED
|
|
- PROVISIONED
|
|
- null
|
|
description: The origin of the account either aggregated or provisioned
|
|
example: AGGREGATED
|
|
ownerIdentity:
|
|
$ref: '#/components/schemas/Account/allOf/1/properties/identity'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/BaseReferenceDto.yaml
|
|
AccountActivity:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: Id of the account activity
|
|
example: 2c9180835d2e5168015d32f890ca1581
|
|
name:
|
|
type: string
|
|
description: The name of the activity
|
|
example: 2c9180835d2e5168015d32f890ca1581
|
|
created:
|
|
description: When the activity was first created
|
|
type: string
|
|
format: date-time
|
|
example: '2017-07-11T18:45:37.098Z'
|
|
modified:
|
|
description: When the activity was last modified
|
|
type: string
|
|
format: date-time
|
|
example: '2018-06-25T20:22:28.104Z'
|
|
nullable: true
|
|
completed:
|
|
description: When the activity was completed
|
|
type: string
|
|
format: date-time
|
|
nullable: true
|
|
example: '2018-10-19T13:49:37.385Z'
|
|
completionStatus:
|
|
nullable: true
|
|
type: string
|
|
description: The status after completion.
|
|
enum:
|
|
- SUCCESS
|
|
- FAILURE
|
|
- INCOMPLETE
|
|
- PENDING
|
|
- null
|
|
example: SUCCESS
|
|
type:
|
|
nullable: true
|
|
type: string
|
|
example: appRequest
|
|
description: |
|
|
The type of action the activity performed. Please see the following list of types. This list may grow over time.
|
|
|
|
- CloudAutomated
|
|
- IdentityAttributeUpdate
|
|
- appRequest
|
|
- LifecycleStateChange
|
|
- AccountStateUpdate
|
|
- AccountAttributeUpdate
|
|
- CloudPasswordRequest
|
|
- Attribute Synchronization Refresh
|
|
- Certification
|
|
- Identity Refresh
|
|
- Lifecycle Change Refresh
|
|
|
|
|
|
[Learn more here](https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data).
|
|
requesterIdentitySummary:
|
|
type: object
|
|
nullable: true
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: ID of this identity summary
|
|
example: ff80818155fe8c080155fe8d925b0316
|
|
name:
|
|
type: string
|
|
description: Human-readable display name of identity
|
|
example: SailPoint Services
|
|
identityId:
|
|
type: string
|
|
description: ID of the identity that this summary represents
|
|
example: c15b9f5cca5a4e9599eaa0e64fa921bd
|
|
completed:
|
|
type: boolean
|
|
description: Indicates if all access items for this summary have been decided on
|
|
example: true
|
|
default: false
|
|
targetIdentitySummary:
|
|
$ref: '#/components/schemas/AccountActivity/properties/requesterIdentitySummary'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/IdentitySummary.yaml
|
|
errors:
|
|
nullable: true
|
|
description: A list of error messages, if any, that were encountered.
|
|
type: array
|
|
items:
|
|
type: string
|
|
example:
|
|
- 'sailpoint.connector.ConnectorException: java.lang.InterruptedException: Timeout waiting for response to message 0 from client 57a4ab97-ab3f-4aef-9fe2-0eaf15c73d26 after 60 seconds.'
|
|
warnings:
|
|
nullable: true
|
|
description: A list of warning messages, if any, that were encountered.
|
|
type: array
|
|
items:
|
|
type: string
|
|
example:
|
|
- Some warning, another warning
|
|
items:
|
|
nullable: true
|
|
type: array
|
|
description: Individual actions performed as part of this account activity
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: Item id
|
|
example: 48c545831b264409a81befcabb0e3c5a
|
|
name:
|
|
type: string
|
|
description: Human-readable display name of item
|
|
example: 48c545831b264409a81befcabb0e3c5a
|
|
requested:
|
|
type: string
|
|
format: date-time
|
|
description: Date and time item was requested
|
|
example: '2017-07-11T18:45:37.098Z'
|
|
approvalStatus:
|
|
type: string
|
|
nullable: true
|
|
enum:
|
|
- FINISHED
|
|
- REJECTED
|
|
- RETURNED
|
|
- EXPIRED
|
|
- PENDING
|
|
- CANCELED
|
|
- null
|
|
example: PENDING
|
|
description: The state of an approval status
|
|
provisioningStatus:
|
|
type: string
|
|
enum:
|
|
- PENDING
|
|
- FINISHED
|
|
- UNVERIFIABLE
|
|
- COMMITED
|
|
- FAILED
|
|
- RETRY
|
|
description: Provisioning state of an account activity item
|
|
example: PENDING
|
|
requesterComment:
|
|
type: object
|
|
nullable: true
|
|
properties:
|
|
commenterId:
|
|
type: string
|
|
description: Id of the identity making the comment
|
|
example: 2c918084660f45d6016617daa9210584
|
|
commenterName:
|
|
type: string
|
|
description: Human-readable display name of the identity making the comment
|
|
example: Adam Kennedy
|
|
body:
|
|
type: string
|
|
description: Content of the comment
|
|
example: Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat.
|
|
date:
|
|
type: string
|
|
format: date-time
|
|
description: Date and time comment was made
|
|
example: '2017-07-11T18:45:37.098Z'
|
|
reviewerIdentitySummary:
|
|
$ref: '#/components/schemas/AccountActivity/properties/requesterIdentitySummary'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/IdentitySummary.yaml
|
|
reviewerComment:
|
|
$ref: '#/components/schemas/AccountActivity/properties/items/items/properties/requesterComment'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/Comment.yaml
|
|
operation:
|
|
type: string
|
|
nullable: true
|
|
enum:
|
|
- ADD
|
|
- CREATE
|
|
- MODIFY
|
|
- DELETE
|
|
- DISABLE
|
|
- ENABLE
|
|
- UNLOCK
|
|
- LOCK
|
|
- REMOVE
|
|
- SET
|
|
- null
|
|
description: Represents an operation in an account activity item
|
|
example: ADD
|
|
attribute:
|
|
type: string
|
|
description: Attribute to which account activity applies
|
|
nullable: true
|
|
example: detectedRoles
|
|
value:
|
|
type: string
|
|
description: Value of attribute
|
|
nullable: true
|
|
example: Treasury Analyst [AccessProfile-1529010191212]
|
|
nativeIdentity:
|
|
nullable: true
|
|
type: string
|
|
description: Native identity in the target system to which the account activity applies
|
|
example: Sandie.Camero
|
|
sourceId:
|
|
type: string
|
|
description: Id of Source to which account activity applies
|
|
example: 2c91808363ef85290164000587130c0c
|
|
accountRequestInfo:
|
|
type: object
|
|
nullable: true
|
|
properties:
|
|
requestedObjectId:
|
|
type: string
|
|
description: Id of requested object
|
|
example: 2c91808563ef85690164001c31140c0c
|
|
requestedObjectName:
|
|
type: string
|
|
description: Human-readable name of requested object
|
|
example: Treasury Analyst
|
|
requestedObjectType:
|
|
$ref: '#/components/schemas/RequestableObject/properties/type'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/RequestableObjectType.yaml
|
|
description: If an account activity item is associated with an access request, captures details of that request.
|
|
clientMetadata:
|
|
nullable: true
|
|
type: object
|
|
additionalProperties:
|
|
type: string
|
|
description: Arbitrary key-value pairs, if any were included in the corresponding access request item
|
|
example:
|
|
customKey1: custom value 1
|
|
customKey2: custom value 2
|
|
removeDate:
|
|
nullable: true
|
|
type: string
|
|
description: The date the role or access profile or entitlement is no longer assigned to the specified identity.
|
|
format: date-time
|
|
example: '2020-07-11T00:00:00Z'
|
|
executionStatus:
|
|
type: string
|
|
description: The current state of execution.
|
|
enum:
|
|
- EXECUTING
|
|
- VERIFYING
|
|
- TERMINATED
|
|
- COMPLETED
|
|
example: COMPLETED
|
|
clientMetadata:
|
|
nullable: true
|
|
type: object
|
|
additionalProperties:
|
|
type: string
|
|
description: Arbitrary key-value pairs, if any were included in the corresponding access request
|
|
example:
|
|
customKey1: custom value 1
|
|
customKey2: custom value 2
|
|
AccountActivitySearchedItem:
|
|
description: AccountActivity
|
|
allOf:
|
|
- type: object
|
|
required:
|
|
- id
|
|
- name
|
|
- _type
|
|
properties:
|
|
id:
|
|
type: string
|
|
example: 2c91808375d8e80a0175e1f88a575222
|
|
name:
|
|
type: string
|
|
example: john.doe
|
|
_type:
|
|
description: |-
|
|
Enum representing the currently supported document types.
|
|
|
|
Additional values may be added in the future without notice.
|
|
type: string
|
|
enum:
|
|
- accessprofile
|
|
- accountactivity
|
|
- account
|
|
- aggregation
|
|
- entitlement
|
|
- event
|
|
- identity
|
|
- role
|
|
example: identity
|
|
- type: object
|
|
properties:
|
|
action:
|
|
type: string
|
|
description: Type of action performed in the activity.
|
|
externalDocs:
|
|
description: Learn more about account activity action types
|
|
url: https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data
|
|
example: Identity Refresh.
|
|
created:
|
|
type: string
|
|
description: ISO-8601 date-time referring to the time when the object was created.
|
|
nullable: true
|
|
format: date-time
|
|
example: '2018-06-25T20:22:28.104Z'
|
|
modified:
|
|
type: string
|
|
description: ISO-8601 date-time referring to the time when the object was last modified.
|
|
nullable: true
|
|
format: date-time
|
|
example: '2018-06-25T20:22:28.104Z'
|
|
stage:
|
|
type: string
|
|
description: Activity's current stage.
|
|
example: Completed
|
|
origin:
|
|
type: string
|
|
description: Activity's origin.
|
|
nullable: true
|
|
example: null
|
|
status:
|
|
type: string
|
|
description: Activity's current status.
|
|
example: Complete
|
|
requester:
|
|
allOf:
|
|
- $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/source'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/Reference.yaml
|
|
- type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: Delimited File
|
|
description: Type of source returned.
|
|
recipient:
|
|
$ref: '#/components/schemas/AccountActivitySearchedItem/allOf/1/properties/requester'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/account/AccountSource.yaml
|
|
trackingNumber:
|
|
type: string
|
|
description: Account activity's tracking number.
|
|
example: 61aad0c9e8134eca89e76a35e0cabe3f
|
|
errors:
|
|
type: array
|
|
description: Errors provided by the source while completing account actions.
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
example: null
|
|
warnings:
|
|
type: array
|
|
description: Warnings provided by the source while completing account actions.
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
example: null
|
|
approvals:
|
|
type: array
|
|
description: Approvals performed on an item during activity.
|
|
items:
|
|
type: object
|
|
properties:
|
|
comments:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
comment:
|
|
type: string
|
|
description: The comment text
|
|
example: This request was autoapproved by our automated ETS subscriber.
|
|
commenter:
|
|
type: string
|
|
description: The name of the commenter
|
|
example: Automated AR Approval
|
|
date:
|
|
$ref: '#/components/schemas/Schedule/properties/expiration'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/DateTime.yaml
|
|
created:
|
|
$ref: '#/components/schemas/Schedule/properties/expiration'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/DateTime.yaml
|
|
modified:
|
|
$ref: '#/components/schemas/Schedule/properties/expiration'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/DateTime.yaml
|
|
owner:
|
|
$ref: '#/components/schemas/AccountActivitySearchedItem/allOf/1/properties/requester'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/account/AccountSource.yaml
|
|
result:
|
|
type: string
|
|
description: The result of the approval
|
|
example: Finished
|
|
type:
|
|
type: string
|
|
nullable: true
|
|
example: null
|
|
originalRequests:
|
|
type: array
|
|
description: Original actions that triggered all individual source actions related to the account action.
|
|
items:
|
|
type: object
|
|
properties:
|
|
accountId:
|
|
type: string
|
|
description: Account ID.
|
|
example: CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com
|
|
attributeRequests:
|
|
type: array
|
|
description: Attribute changes requested for account.
|
|
items:
|
|
type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Attribute name.
|
|
example: groups
|
|
op:
|
|
type: string
|
|
description: Operation to perform on attribute.
|
|
example: Add
|
|
value:
|
|
type: string
|
|
description: Value of attribute.
|
|
example: '3203537556531076'
|
|
op:
|
|
type: string
|
|
description: Operation used.
|
|
example: add
|
|
source:
|
|
description: Account's source.
|
|
$ref: '#/components/schemas/AccountActivitySearchedItem/allOf/1/properties/requester'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/account/AccountSource.yaml
|
|
expansionItems:
|
|
type: array
|
|
description: Controls that translated the attribute requests into actual provisioning actions on the source.
|
|
items:
|
|
type: object
|
|
properties:
|
|
accountId:
|
|
type: string
|
|
description: The ID of the account
|
|
example: 2c91808981f58ea601821c3e93482e6f
|
|
cause:
|
|
type: string
|
|
example: Role
|
|
name:
|
|
type: string
|
|
description: The name of the item
|
|
example: smartsheet-role
|
|
attributeRequests:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/AccountActivitySearchedItem/allOf/1/properties/originalRequests/items/properties/attributeRequests/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/account/activity/AttributeRequest.yaml
|
|
source:
|
|
$ref: '#/components/schemas/AccountActivitySearchedItem/allOf/1/properties/requester'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/account/AccountSource.yaml
|
|
accountRequests:
|
|
type: array
|
|
description: Account data for each individual source action triggered by the original requests.
|
|
items:
|
|
type: object
|
|
properties:
|
|
accountId:
|
|
type: string
|
|
description: Unique ID of the account
|
|
example: John.Doe
|
|
attributeRequests:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/AccountActivitySearchedItem/allOf/1/properties/originalRequests/items/properties/attributeRequests/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/account/activity/AttributeRequest.yaml
|
|
op:
|
|
type: string
|
|
example: Modify
|
|
description: The operation that was performed
|
|
provisioningTarget:
|
|
$ref: '#/components/schemas/AccountActivitySearchedItem/allOf/1/properties/requester'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/account/AccountSource.yaml
|
|
result:
|
|
type: object
|
|
properties:
|
|
errors:
|
|
type: array
|
|
items:
|
|
type: string
|
|
example: |-
|
|
[ConnectorError] [
|
|
{
|
|
"code": "unrecognized_keys",
|
|
"keys": [
|
|
"groups"
|
|
],
|
|
"path": [],
|
|
"message": "Unrecognized key(s) in object: 'groups'"
|
|
}
|
|
] (requestId: 5e9d6df5-9b1b-47d9-9bf1-dc3a2893299e)
|
|
status:
|
|
type: string
|
|
description: The status of the account request
|
|
example: failed
|
|
ticketId:
|
|
type: string
|
|
nullable: true
|
|
example: null
|
|
source:
|
|
$ref: '#/components/schemas/AccountActivitySearchedItem/allOf/1/properties/requester'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/account/AccountSource.yaml
|
|
sources:
|
|
type: string
|
|
description: Sources involved in the account activity.
|
|
example: smartsheet-test, airtable-v4, IdentityNow
|
|
AccountAttributes:
|
|
type: object
|
|
required:
|
|
- attributes
|
|
properties:
|
|
attributes:
|
|
description: The schema attribute values for the account
|
|
type: object
|
|
additionalProperties: true
|
|
example:
|
|
city: Austin
|
|
displayName: John Doe
|
|
userName: jdoe
|
|
sAMAccountName: jDoe
|
|
mail: john.doe@sailpoint.com
|
|
AccountsAsyncResult:
|
|
description: Accounts async response containing details on started async process
|
|
required:
|
|
- id
|
|
type: object
|
|
properties:
|
|
id:
|
|
description: id of the task
|
|
type: string
|
|
example: 2c91808474683da6017468693c260195
|
|
AccountToggleRequest:
|
|
description: Request used for account enable/disable
|
|
type: object
|
|
properties:
|
|
externalVerificationId:
|
|
description: If set, an external process validates that the user wants to proceed with this request.
|
|
type: string
|
|
example: 3f9180835d2e5168015d32f890ca1581
|
|
forceProvisioning:
|
|
description: If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. Providing 'true' for an unlocked account will add and process 'Unlock' operation by the workflow.
|
|
type: boolean
|
|
example: false
|
|
AccountUnlockRequest:
|
|
description: Request used for account unlock
|
|
type: object
|
|
properties:
|
|
externalVerificationId:
|
|
description: If set, an external process validates that the user wants to proceed with this request.
|
|
type: string
|
|
example: 3f9180835d2e5168015d32f890ca1581
|
|
unlockIDNAccount:
|
|
description: If set, the IDN account is unlocked after the workflow completes.
|
|
type: boolean
|
|
example: false
|
|
forceProvisioning:
|
|
description: If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated.
|
|
type: boolean
|
|
example: false
|
|
ApprovalItems:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The approval item's ID
|
|
example: 2c9180835d2e5168015d32f890ca1581
|
|
account:
|
|
type: string
|
|
description: The account referenced by the approval item
|
|
example: john.smith
|
|
nullable: true
|
|
application:
|
|
type: string
|
|
description: The name of the application/source
|
|
example: Active Directory
|
|
name:
|
|
type: string
|
|
description: The attribute's name
|
|
example: emailAddress
|
|
nullable: true
|
|
operation:
|
|
type: string
|
|
description: The attribute's operation
|
|
example: update
|
|
value:
|
|
type: string
|
|
description: The attribute's value
|
|
example: a@b.com
|
|
nullable: true
|
|
state:
|
|
allOf:
|
|
- type: string
|
|
nullable: true
|
|
enum:
|
|
- Finished
|
|
- Rejected
|
|
- Returned
|
|
- Expired
|
|
- Pending
|
|
- Canceled
|
|
- null
|
|
example: Pending
|
|
description: The state of a work item
|
|
- nullable: true
|
|
Campaign:
|
|
type: object
|
|
required:
|
|
- id
|
|
- name
|
|
- type
|
|
- campaignType
|
|
- description
|
|
- correlatedStatus
|
|
- mandatoryCommentRequirement
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The unique ID of the campaign.
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
name:
|
|
type: string
|
|
description: The name of the campaign.
|
|
example: Campaign Name
|
|
type:
|
|
type: string
|
|
enum:
|
|
- CAMPAIGN
|
|
description: The type of object that is being referenced.
|
|
example: CAMPAIGN
|
|
campaignType:
|
|
type: string
|
|
enum:
|
|
- MANAGER
|
|
- SOURCE_OWNER
|
|
- SEARCH
|
|
description: The type of the campaign.
|
|
example: MANAGER
|
|
description:
|
|
type: string
|
|
description: The description of the campaign set by the admin who created it.
|
|
nullable: true
|
|
example: A description of the campaign
|
|
correlatedStatus:
|
|
type: string
|
|
description: The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).
|
|
enum:
|
|
- CORRELATED
|
|
- UNCORRELATED
|
|
example: CORRELATED
|
|
mandatoryCommentRequirement:
|
|
type: string
|
|
description: Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions.
|
|
enum:
|
|
- ALL_DECISIONS
|
|
- REVOKE_ONLY_DECISIONS
|
|
- NO_DECISIONS
|
|
example: NO_DECISIONS
|
|
Certification:
|
|
type: object
|
|
properties:
|
|
id:
|
|
example: 2c9180835d2e5168015d32f890ca1581
|
|
type: string
|
|
description: id of the certification
|
|
name:
|
|
example: Source Owner Access Review for Employees [source]
|
|
type: string
|
|
description: name of the certification
|
|
campaign:
|
|
type: object
|
|
required:
|
|
- id
|
|
- name
|
|
- type
|
|
- campaignType
|
|
- description
|
|
- correlatedStatus
|
|
- mandatoryCommentRequirement
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The unique ID of the campaign.
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
name:
|
|
type: string
|
|
description: The name of the campaign.
|
|
example: Campaign Name
|
|
type:
|
|
type: string
|
|
enum:
|
|
- CAMPAIGN
|
|
description: The type of object that is being referenced.
|
|
example: CAMPAIGN
|
|
campaignType:
|
|
type: string
|
|
enum:
|
|
- MANAGER
|
|
- SOURCE_OWNER
|
|
- SEARCH
|
|
description: The type of the campaign.
|
|
example: MANAGER
|
|
description:
|
|
type: string
|
|
description: The description of the campaign set by the admin who created it.
|
|
nullable: true
|
|
example: A description of the campaign
|
|
correlatedStatus:
|
|
type: string
|
|
description: The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).
|
|
enum:
|
|
- CORRELATED
|
|
- UNCORRELATED
|
|
example: CORRELATED
|
|
mandatoryCommentRequirement:
|
|
type: string
|
|
description: Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions.
|
|
enum:
|
|
- ALL_DECISIONS
|
|
- REVOKE_ONLY_DECISIONS
|
|
- NO_DECISIONS
|
|
example: NO_DECISIONS
|
|
completed:
|
|
type: boolean
|
|
description: Have all decisions been made?
|
|
example: true
|
|
identitiesCompleted:
|
|
type: integer
|
|
description: The number of identities for whom all decisions have been made and are complete.
|
|
example: 5
|
|
format: int32
|
|
identitiesTotal:
|
|
type: integer
|
|
description: The total number of identities in the Certification, both complete and incomplete.
|
|
example: 10
|
|
format: int32
|
|
created:
|
|
example: '2018-06-25T20:22:28.104Z'
|
|
format: date-time
|
|
type: string
|
|
description: created date
|
|
modified:
|
|
example: '2018-06-25T20:22:28.104Z'
|
|
format: date-time
|
|
type: string
|
|
description: modified date
|
|
decisionsMade:
|
|
type: integer
|
|
description: The number of approve/revoke/acknowledge decisions that have been made.
|
|
example: 20
|
|
format: int32
|
|
decisionsTotal:
|
|
type: integer
|
|
description: The total number of approve/revoke/acknowledge decisions.
|
|
example: 40
|
|
format: int32
|
|
due:
|
|
type: string
|
|
format: date-time
|
|
description: The due date of the certification.
|
|
example: '2018-10-19T13:49:37.385Z'
|
|
signed:
|
|
type: string
|
|
format: date-time
|
|
nullable: true
|
|
description: The date the reviewer signed off on the Certification.
|
|
example: '2018-10-19T13:49:37.385Z'
|
|
reviewer:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The id of the reviewer.
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
name:
|
|
type: string
|
|
description: The name of the reviewer.
|
|
example: Reviewer Name
|
|
email:
|
|
type: string
|
|
description: The email of the reviewing identity.
|
|
example: reviewer@test.com
|
|
type:
|
|
type: string
|
|
enum:
|
|
- IDENTITY
|
|
description: The type of the reviewing identity.
|
|
example: IDENTITY
|
|
created:
|
|
nullable: true
|
|
example: '2018-06-25T20:22:28.104Z'
|
|
format: date-time
|
|
type: string
|
|
description: The created date of the reviewing identity.
|
|
modified:
|
|
nullable: true
|
|
example: '2018-06-25T20:22:28.104Z'
|
|
format: date-time
|
|
type: string
|
|
description: The modified date of the reviewing identity.
|
|
reassignment:
|
|
type: object
|
|
nullable: true
|
|
properties:
|
|
from:
|
|
$ref: '#/components/schemas/Reassignment/properties/from'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/CertificationReference.yaml
|
|
comment:
|
|
type: string
|
|
description: The comment entered when the Certification was reassigned
|
|
example: Reassigned for a reason
|
|
hasErrors:
|
|
description: Identifies if the certification has an error
|
|
type: boolean
|
|
example: false
|
|
errorMessage:
|
|
description: Description of the certification error
|
|
nullable: true
|
|
type: string
|
|
example: The certification has an error
|
|
phase:
|
|
type: string
|
|
description: |
|
|
The current phase of the campaign.
|
|
* `STAGED`: The campaign is waiting to be activated.
|
|
* `ACTIVE`: The campaign is active.
|
|
* `SIGNED`: The reviewer has signed off on the campaign, and it is considered complete.
|
|
enum:
|
|
- STAGED
|
|
- ACTIVE
|
|
- SIGNED
|
|
example: ACTIVE
|
|
CertificationReference:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The id of the certification.
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
name:
|
|
type: string
|
|
description: The name of the certification.
|
|
example: Certification Name
|
|
type:
|
|
type: string
|
|
enum:
|
|
- CERTIFICATION
|
|
example: CERTIFICATION
|
|
reviewer:
|
|
$ref: '#/components/schemas/Certification/properties/reviewer'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/Reviewer.yaml
|
|
EntitlementDocument:
|
|
description: Entitlement
|
|
allOf:
|
|
- $ref: '#/components/schemas/AccountActivitySearchedItem/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/BaseDocument.yaml
|
|
- type: object
|
|
properties:
|
|
modified:
|
|
type: string
|
|
description: ISO-8601 date-time referring to the time when the object was last modified.
|
|
nullable: true
|
|
format: date-time
|
|
example: '2018-06-25T20:22:28.104Z'
|
|
synced:
|
|
type: string
|
|
description: |-
|
|
ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API.
|
|
This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database.
|
|
There may be some delay between the `synced` time and the time when the updated data is actually available in the search API.
|
|
displayName:
|
|
type: string
|
|
description: Entitlement's display name.
|
|
example: Admin
|
|
source:
|
|
type: object
|
|
description: Entitlement's source.
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: ID of entitlement's source.
|
|
example: 2c91808b6e9e6fb8016eec1a2b6f7b5f
|
|
name:
|
|
type: string
|
|
description: Display name of entitlement's source.
|
|
example: ODS-HR-Employees
|
|
segments:
|
|
type: array
|
|
description: Segments with the role.
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
example: b009b6e3-b56d-41d9-8735-cb532ea0b017
|
|
description: Segment's unique ID.
|
|
name:
|
|
type: string
|
|
example: Test Segment
|
|
description: Segment's display name.
|
|
segmentCount:
|
|
type: integer
|
|
description: Number of segments with the role.
|
|
format: int32
|
|
example: 1
|
|
requestable:
|
|
type: boolean
|
|
description: Indicates whether the entitlement is requestable.
|
|
default: false
|
|
example: false
|
|
cloudGoverned:
|
|
type: boolean
|
|
description: Indicates whether the entitlement is cloud governed.
|
|
default: false
|
|
example: false
|
|
created:
|
|
type: string
|
|
description: ISO-8601 date-time referring to the time when the object was created.
|
|
nullable: true
|
|
format: date-time
|
|
example: '2018-06-25T20:22:28.104Z'
|
|
privileged:
|
|
type: boolean
|
|
description: Indicates whether the entitlement is privileged.
|
|
default: false
|
|
example: false
|
|
identityCount:
|
|
type: integer
|
|
description: Number of identities who have access to the entitlement.
|
|
format: int32
|
|
example: 3
|
|
tags:
|
|
$ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/tags'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/Tags.yaml
|
|
EntitlementSummary:
|
|
description: EntitlementReference
|
|
allOf:
|
|
- $ref: '#/components/schemas/AccessProfileSummary/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/access/Access.yaml
|
|
- type: object
|
|
properties:
|
|
source:
|
|
$ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/source'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/Reference.yaml
|
|
privileged:
|
|
type: boolean
|
|
example: false
|
|
attribute:
|
|
type: string
|
|
example: memberOf
|
|
value:
|
|
type: string
|
|
example: CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com
|
|
standalone:
|
|
type: boolean
|
|
example: false
|
|
Event:
|
|
description: Event
|
|
allOf:
|
|
- $ref: '#/components/schemas/AccountActivitySearchedItem/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/BaseDocument.yaml
|
|
- type: object
|
|
properties:
|
|
created:
|
|
type: string
|
|
description: ISO-8601 date-time referring to the time when the object was created.
|
|
nullable: true
|
|
format: date-time
|
|
example: '2018-06-25T20:22:28.104Z'
|
|
synced:
|
|
type: string
|
|
description: |-
|
|
ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API.
|
|
This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database.
|
|
There may be some delay between the `synced` time and the time when the updated data is actually available in the search API.
|
|
action:
|
|
type: string
|
|
description: Name of the event as it's displayed in audit reports.
|
|
example: update
|
|
type:
|
|
type: string
|
|
description: Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings.
|
|
example: SYSTEM_CONFIG
|
|
actor:
|
|
type: string
|
|
description: Name of the actor that generated the event.
|
|
example: System
|
|
target:
|
|
type: string
|
|
description: Name of the target, or recipient, of the event.
|
|
example: Carol.Adams
|
|
stack:
|
|
type: string
|
|
description: The event's stack.
|
|
example: tpe
|
|
trackingNumber:
|
|
type: string
|
|
description: ID of the group of events.
|
|
example: 63f891e0735f4cc8bf1968144a1e7440
|
|
ipAddress:
|
|
type: string
|
|
description: Target system's IP address.
|
|
example: 52.52.97.85
|
|
details:
|
|
type: string
|
|
description: ID of event's details.
|
|
example: 73b65dfbed1842548c207432a18c84b0
|
|
attributes:
|
|
type: object
|
|
description: Attributes involved in the event.
|
|
additionalProperties: true
|
|
example:
|
|
pod: stg03-useast1
|
|
org: acme
|
|
sourceName: SailPoint
|
|
objects:
|
|
type: array
|
|
description: Objects the event is happening to.
|
|
items:
|
|
type: string
|
|
example: AUTHENTICATION
|
|
operation:
|
|
type: string
|
|
description: Operation, or action, performed during the event.
|
|
example: REQUEST
|
|
status:
|
|
type: string
|
|
description: Event status. Refer to [Event Statuses](https://documentation.sailpoint.com/saas/help/search/index.html#event-statuses) for a list of event statuses and their meanings.
|
|
example: PASSED
|
|
technicalName:
|
|
type: string
|
|
description: Event's normalized name. This normalized name always follows the pattern of 'objects_operation_status'.
|
|
example: AUTHENTICATION_REQUEST_PASSED
|
|
IdentityDocument:
|
|
description: Identity
|
|
allOf:
|
|
- $ref: '#/components/schemas/AccountActivitySearchedItem/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/BaseDocument.yaml
|
|
- $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/owner'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/DisplayReference.yaml
|
|
- type: object
|
|
properties:
|
|
displayName:
|
|
type: string
|
|
example: Carol.Adams
|
|
description: Identity's display name.
|
|
firstName:
|
|
type: string
|
|
description: Identity's first name.
|
|
example: Carol
|
|
lastName:
|
|
type: string
|
|
description: Identity's last name.
|
|
example: Adams
|
|
email:
|
|
type: string
|
|
description: Identity's primary email address.
|
|
example: Carol.Adams@sailpointdemo.com
|
|
created:
|
|
type: string
|
|
description: ISO-8601 date-time referring to the time when the object was created.
|
|
nullable: true
|
|
format: date-time
|
|
example: '2018-06-25T20:22:28.104Z'
|
|
modified:
|
|
type: string
|
|
description: ISO-8601 date-time referring to the time when the object was last modified.
|
|
nullable: true
|
|
format: date-time
|
|
example: '2018-06-25T20:22:28.104Z'
|
|
phone:
|
|
type: string
|
|
description: Identity's phone number.
|
|
example: +1 440-527-3672
|
|
synced:
|
|
type: string
|
|
description: |-
|
|
ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API.
|
|
This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database.
|
|
There may be some delay between the `synced` time and the time when the updated data is actually available in the search API.
|
|
inactive:
|
|
type: boolean
|
|
description: Indicates whether the identity is inactive.
|
|
default: false
|
|
example: false
|
|
protected:
|
|
type: boolean
|
|
description: Indicates whether the identity is protected.
|
|
default: false
|
|
example: false
|
|
status:
|
|
type: string
|
|
description: Identity's status in SailPoint.
|
|
example: UNREGISTERED
|
|
employeeNumber:
|
|
type: string
|
|
description: Identity's employee number.
|
|
example: 1a2a3d4e
|
|
manager:
|
|
type: object
|
|
description: Identity's manager.
|
|
nullable: true
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: ID of identity's manager.
|
|
example: 2c9180867dfe694b017e208e27c05799
|
|
name:
|
|
type: string
|
|
description: Name of identity's manager.
|
|
example: Amanda.Ross
|
|
displayName:
|
|
type: string
|
|
description: Display name of identity's manager.
|
|
example: Amanda.Ross
|
|
isManager:
|
|
type: boolean
|
|
description: Indicates whether the identity is a manager of other identities.
|
|
example: false
|
|
identityProfile:
|
|
type: object
|
|
description: Identity's identity profile.
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: Identity profile's ID.
|
|
example: 3bc8ad26b8664945866b31339d1ff7d2
|
|
name:
|
|
type: string
|
|
description: Identity profile's name.
|
|
example: HR Employees
|
|
source:
|
|
type: object
|
|
description: Identity's source.
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: ID of identity's source.
|
|
example: 2c91808b6e9e6fb8016eec1a2b6f7b5f
|
|
name:
|
|
type: string
|
|
description: Display name of identity's source.
|
|
example: ODS-HR-Employees
|
|
attributes:
|
|
type: object
|
|
description: Map or dictionary of key/value pairs.
|
|
additionalProperties: true
|
|
example:
|
|
country: US
|
|
firstname: Carol
|
|
cloudStatus: UNREGISTERED
|
|
processingState:
|
|
type: string
|
|
description: Identity's processing state.
|
|
nullable: true
|
|
example: null
|
|
processingDetails:
|
|
type: object
|
|
properties:
|
|
date:
|
|
$ref: '#/components/schemas/Schedule/properties/expiration'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/DateTime.yaml
|
|
stage:
|
|
type: string
|
|
example: In Process
|
|
retryCount:
|
|
type: integer
|
|
example: 0
|
|
format: int32
|
|
stackTrace:
|
|
type: string
|
|
example: <stack trace>
|
|
message:
|
|
type: string
|
|
example: <message>
|
|
accounts:
|
|
type: array
|
|
description: List of accounts associated with the identity.
|
|
items:
|
|
allOf:
|
|
- $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/source'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/Reference.yaml
|
|
- type: object
|
|
properties:
|
|
accountId:
|
|
type: string
|
|
description: Account ID.
|
|
example: John.Doe
|
|
source:
|
|
$ref: '#/components/schemas/AccountActivitySearchedItem/allOf/1/properties/requester'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/account/AccountSource.yaml
|
|
disabled:
|
|
type: boolean
|
|
description: Indicates whether the account is disabled.
|
|
default: false
|
|
example: false
|
|
locked:
|
|
type: boolean
|
|
description: Indicates whether the account is locked.
|
|
default: false
|
|
example: false
|
|
privileged:
|
|
type: boolean
|
|
description: Indicates whether the account is privileged.
|
|
default: false
|
|
example: false
|
|
manuallyCorrelated:
|
|
type: boolean
|
|
description: Indicates whether the account has been manually correlated to an identity.
|
|
default: false
|
|
example: false
|
|
passwordLastSet:
|
|
$ref: '#/components/schemas/Schedule/properties/expiration'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/DateTime.yaml
|
|
entitlementAttributes:
|
|
type: object
|
|
nullable: true
|
|
description: Map or dictionary of key/value pairs.
|
|
additionalProperties: true
|
|
example:
|
|
moderator: true
|
|
admin: true
|
|
trust_level: '4'
|
|
created:
|
|
type: string
|
|
description: ISO-8601 date-time referring to the time when the object was created.
|
|
nullable: true
|
|
format: date-time
|
|
example: '2018-06-25T20:22:28.104Z'
|
|
accountCount:
|
|
type: integer
|
|
description: Number of accounts associated with the identity.
|
|
format: int32
|
|
example: 3
|
|
apps:
|
|
type: array
|
|
description: List of applications the identity has access to.
|
|
items:
|
|
allOf:
|
|
- $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/source'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/Reference.yaml
|
|
- type: object
|
|
properties:
|
|
source:
|
|
$ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/source'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/Reference.yaml
|
|
account:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The SailPoint generated unique ID
|
|
example: 2c9180837dfe6949017e21f3d8cd6d49
|
|
accountId:
|
|
type: string
|
|
description: The account ID generated by the source
|
|
example: CN=Carol Adams,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=sailpointdemo,DC=com
|
|
appCount:
|
|
type: integer
|
|
format: int32
|
|
description: Number of applications the identity has access to.
|
|
example: 2
|
|
access:
|
|
type: array
|
|
description: List of access items assigned to the identity.
|
|
items:
|
|
discriminator:
|
|
propertyName: type
|
|
mapping:
|
|
ACCESS_PROFILE: ../access/AccessProfileSummary.yaml
|
|
ENTITLEMENT: ../access/AccessProfileEntitlement.yaml
|
|
ROLE: ../access/AccessProfileRole.yaml
|
|
oneOf:
|
|
- description: This is a summary representation of an access profile.
|
|
allOf:
|
|
- $ref: '#/components/schemas/AccessProfileSummary/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/access/Access.yaml
|
|
- type: object
|
|
properties:
|
|
source:
|
|
$ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/source'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/Reference.yaml
|
|
owner:
|
|
$ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/owner'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/DisplayReference.yaml
|
|
revocable:
|
|
type: boolean
|
|
example: true
|
|
- description: EntitlementReference
|
|
allOf:
|
|
- $ref: '#/components/schemas/AccessProfileSummary/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/access/Access.yaml
|
|
- type: object
|
|
properties:
|
|
source:
|
|
$ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/source'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/Reference.yaml
|
|
privileged:
|
|
type: boolean
|
|
example: false
|
|
attribute:
|
|
type: string
|
|
example: memberOf
|
|
value:
|
|
type: string
|
|
example: CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com
|
|
standalone:
|
|
type: boolean
|
|
example: false
|
|
- description: Role
|
|
allOf:
|
|
- $ref: '#/components/schemas/AccessProfileSummary/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/access/Access.yaml
|
|
- type: object
|
|
properties:
|
|
owner:
|
|
$ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/owner'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/DisplayReference.yaml
|
|
disabled:
|
|
type: boolean
|
|
revocable:
|
|
type: boolean
|
|
accessCount:
|
|
type: integer
|
|
format: int32
|
|
description: Number of access items assigned to the identity.
|
|
example: 5
|
|
entitlementCount:
|
|
type: integer
|
|
format: int32
|
|
description: Number of entitlements assigned to the identity.
|
|
example: 10
|
|
roleCount:
|
|
type: integer
|
|
format: int32
|
|
description: Number of roles assigned to the identity.
|
|
example: 1
|
|
accessProfileCount:
|
|
type: integer
|
|
format: int32
|
|
description: Number of access profiles assigned to the identity.
|
|
example: 1
|
|
owns:
|
|
type: array
|
|
description: Access items the identity owns.
|
|
items:
|
|
type: object
|
|
properties:
|
|
sources:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/source'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/Reference.yaml
|
|
entitlements:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/source'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/Reference.yaml
|
|
accessProfiles:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/source'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/Reference.yaml
|
|
roles:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/source'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/Reference.yaml
|
|
apps:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/source'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/Reference.yaml
|
|
governanceGroups:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/source'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/Reference.yaml
|
|
fallbackApprover:
|
|
type: boolean
|
|
example: false
|
|
ownsCount:
|
|
type: integer
|
|
format: int32
|
|
description: Number of access items the identity owns.
|
|
example: 5
|
|
tags:
|
|
$ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/tags'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/Tags.yaml
|
|
IdentityProfile:
|
|
allOf:
|
|
- $ref: '#/components/schemas/Account/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/BaseCommonDto.yaml
|
|
- type: object
|
|
required:
|
|
- authoritativeSource
|
|
properties:
|
|
description:
|
|
type: string
|
|
description: The description of the Identity Profile.
|
|
example: My custom flat file profile
|
|
nullable: true
|
|
owner:
|
|
type: object
|
|
description: The owner of the Identity Profile.
|
|
nullable: true
|
|
properties:
|
|
type:
|
|
type: string
|
|
enum:
|
|
- IDENTITY
|
|
description: Type of the object to which this reference applies
|
|
example: IDENTITY
|
|
id:
|
|
type: string
|
|
description: ID of the object to which this reference applies
|
|
example: 2c9180835d191a86015d28455b4b232a
|
|
name:
|
|
type: string
|
|
description: Human-readable display name of the object to which this reference applies
|
|
example: William Wilson
|
|
priority:
|
|
type: integer
|
|
format: int64
|
|
description: The priority for an Identity Profile.
|
|
example: 10
|
|
authoritativeSource:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
enum:
|
|
- SOURCE
|
|
description: Type of the object to which this reference applies
|
|
example: SOURCE
|
|
id:
|
|
type: string
|
|
description: ID of the object to which this reference applies
|
|
example: 2c9180835d191a86015d28455b4b232a
|
|
name:
|
|
type: string
|
|
description: Human-readable display name of the object to which this reference applies
|
|
example: HR Active Directory
|
|
identityRefreshRequired:
|
|
type: boolean
|
|
default: false
|
|
description: True if a identity refresh is needed. Typically triggered when a change on the source has been made.
|
|
example: true
|
|
identityCount:
|
|
type: integer
|
|
description: The number of identities that belong to the Identity Profile.
|
|
format: int32
|
|
example: 8
|
|
identityAttributeConfig:
|
|
type: object
|
|
description: Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process.
|
|
properties:
|
|
enabled:
|
|
description: The backend will only promote values if the profile/mapping is enabled.
|
|
type: boolean
|
|
default: false
|
|
example: true
|
|
attributeTransforms:
|
|
type: array
|
|
items:
|
|
type: object
|
|
description: Defines a transformation definition for an identity attribute.
|
|
properties:
|
|
identityAttributeName:
|
|
type: string
|
|
description: Name of the identity attribute.
|
|
example: email
|
|
transformDefinition:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: The type of the transform definition.
|
|
example: accountAttribute
|
|
attributes:
|
|
type: object
|
|
additionalProperties: true
|
|
description: Arbitrary key-value pairs to store any metadata for the object
|
|
example:
|
|
attributeName: e-mail
|
|
sourceName: MySource
|
|
sourceId: 2c9180877a826e68017a8c0b03da1a53
|
|
identityExceptionReportReference:
|
|
type: object
|
|
nullable: true
|
|
properties:
|
|
taskResultId:
|
|
type: string
|
|
format: uuid
|
|
description: The id of the task result.
|
|
example: 2b838de9-db9b-abcf-e646-d4f274ad4238
|
|
reportName:
|
|
type: string
|
|
example: My annual report
|
|
description: The name of the report.
|
|
hasTimeBasedAttr:
|
|
description: Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile.
|
|
type: boolean
|
|
default: false
|
|
example: true
|
|
IdentityReferenceWithNameAndEmail:
|
|
type: object
|
|
nullable: true
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: The type can only be IDENTITY. This is read-only.
|
|
example: IDENTITY
|
|
id:
|
|
type: string
|
|
description: Identity ID.
|
|
example: 5168015d32f890ca15812c9180835d2e
|
|
name:
|
|
type: string
|
|
description: Identity's human-readable display name. This is read-only.
|
|
example: Alison Ferguso
|
|
email:
|
|
type: string
|
|
description: Identity's email address. This is read-only.
|
|
example: alison.ferguso@identitysoon.com
|
|
ProvisioningConfig:
|
|
type: object
|
|
description: Specification of a Service Desk integration provisioning configuration.
|
|
properties:
|
|
universalManager:
|
|
description: Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.
|
|
type: boolean
|
|
readOnly: true
|
|
default: false
|
|
example: true
|
|
managedResourceRefs:
|
|
description: References to sources for the Service Desk integration template. May only be specified if universalManager is false.
|
|
type: array
|
|
items:
|
|
allOf:
|
|
- type: object
|
|
description: Source for Service Desk integration template.
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: DTO type of source for service desk integration template.
|
|
enum:
|
|
- SOURCE
|
|
example: SOURCE
|
|
id:
|
|
type: string
|
|
description: ID of source for service desk integration template.
|
|
example: 2c9180835d191a86015d28455b4b232a
|
|
name:
|
|
type: string
|
|
description: Human-readable name of source for service desk integration template.
|
|
example: HR Active Directory
|
|
example:
|
|
- type: SOURCE
|
|
id: 2c9180855d191c59015d291ceb051111
|
|
name: My Source 1
|
|
- type: SOURCE
|
|
id: 2c9180855d191c59015d291ceb052222
|
|
name: My Source 2
|
|
planInitializerScript:
|
|
description: This is a reference to a plan initializer script.
|
|
type: object
|
|
nullable: true
|
|
properties:
|
|
source:
|
|
description: This is a Rule that allows provisioning instruction changes.
|
|
type: string
|
|
example: |
|
|
<?xml version='1.0' encoding='UTF-8'?>\r\n<!DOCTYPE Rule PUBLIC \"sailpoint.dtd\" \"sailpoint.dtd\">\r\n<Rule name=\"Example Rule\" type=\"BeforeProvisioning\">\r\n <Description>Before Provisioning Rule which changes disables and enables to a modify.</Description>\r\n <Source><![CDATA[\r\nimport sailpoint.object.*;\r\nimport sailpoint.object.ProvisioningPlan.AccountRequest;\r\nimport sailpoint.object.ProvisioningPlan.AccountRequest.Operation;\r\nimport sailpoint.object.ProvisioningPlan.AttributeRequest;\r\nimport sailpoint.object.ProvisioningPlan;\r\nimport sailpoint.object.ProvisioningPlan.Operation;\r\n\r\nfor ( AccountRequest accountRequest : plan.getAccountRequests() ) {\r\n if ( accountRequest.getOp().equals( ProvisioningPlan.ObjectOperation.Disable ) ) {\r\n accountRequest.setOp( ProvisioningPlan.ObjectOperation.Modify );\r\n }\r\n if ( accountRequest.getOp().equals( ProvisioningPlan.ObjectOperation.Enable ) ) {\r\n accountRequest.setOp( ProvisioningPlan.ObjectOperation.Modify );\r\n }\r\n}\r\n\r\n ]]></Source>
|
|
noProvisioningRequests:
|
|
description: Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration.
|
|
type: boolean
|
|
default: false
|
|
example: true
|
|
provisioningRequestExpiration:
|
|
description: When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation.
|
|
type: integer
|
|
format: int32
|
|
example: 7
|
|
ProvisioningPolicy:
|
|
type: object
|
|
required:
|
|
- name
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: the provisioning policy name
|
|
example: example provisioning policy for inactive identities
|
|
description:
|
|
type: string
|
|
description: the description of the provisioning policy
|
|
example: this provisioning policy creates access based on an identity going inactive
|
|
usageType:
|
|
type: string
|
|
nullable: false
|
|
enum:
|
|
- CREATE
|
|
- UPDATE
|
|
- ENABLE
|
|
- DISABLE
|
|
- DELETE
|
|
- ASSIGN
|
|
- UNASSIGN
|
|
- CREATE_GROUP
|
|
- UPDATE_GROUP
|
|
- DELETE_GROUP
|
|
- REGISTER
|
|
- CREATE_IDENTITY
|
|
- UPDATE_IDENTITY
|
|
- EDIT_GROUP
|
|
- UNLOCK
|
|
- CHANGE_PASSWORD
|
|
example: CREATE
|
|
description: |-
|
|
The type of provisioning policy usage.
|
|
In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined.
|
|
These are the common usage types:
|
|
CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source.
|
|
UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source.
|
|
ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created.
|
|
DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source.
|
|
You can use these four usage types for all your provisioning policy needs.
|
|
fields:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: The name of the attribute.
|
|
example: userName
|
|
transform:
|
|
type: object
|
|
description: The transform to apply to the field
|
|
example:
|
|
type: rule
|
|
attributes:
|
|
name: Create Unique LDAP Attribute
|
|
default: {}
|
|
attributes:
|
|
type: object
|
|
description: Attributes required for the transform
|
|
example:
|
|
template: ${firstname}.${lastname}${uniqueCounter}
|
|
cloudMaxUniqueChecks: '50'
|
|
cloudMaxSize: '20'
|
|
cloudRequired: 'true'
|
|
isRequired:
|
|
type: boolean
|
|
readOnly: true
|
|
description: Flag indicating whether or not the attribute is required.
|
|
default: false
|
|
example: false
|
|
type:
|
|
type: string
|
|
description: The type of the attribute.
|
|
example: string
|
|
isMultiValued:
|
|
type: boolean
|
|
description: Flag indicating whether or not the attribute is multi-valued.
|
|
default: false
|
|
example: false
|
|
QueuedCheckConfigDetails:
|
|
description: Configuration of maximum number of days and interval for checking Service Desk integration queue status.
|
|
required:
|
|
- provisioningStatusCheckIntervalMinutes
|
|
- provisioningMaxStatusCheckDays
|
|
type: object
|
|
properties:
|
|
provisioningStatusCheckIntervalMinutes:
|
|
description: Interval in minutes between status checks
|
|
type: string
|
|
example: 30
|
|
provisioningMaxStatusCheckDays:
|
|
description: Maximum number of days to check
|
|
type: string
|
|
example: 2
|
|
Reassignment:
|
|
type: object
|
|
nullable: true
|
|
properties:
|
|
from:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The id of the certification.
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
name:
|
|
type: string
|
|
description: The name of the certification.
|
|
example: Certification Name
|
|
type:
|
|
type: string
|
|
enum:
|
|
- CERTIFICATION
|
|
example: CERTIFICATION
|
|
reviewer:
|
|
$ref: '#/components/schemas/Certification/properties/reviewer'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/Reviewer.yaml
|
|
comment:
|
|
type: string
|
|
description: The comment entered when the Certification was reassigned
|
|
example: Reassigned for a reason
|
|
ReassignmentReference:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The ID of item or identity being reassigned.
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
type:
|
|
type: string
|
|
description: The type of item or identity being reassigned.
|
|
enum:
|
|
- TARGET_SUMMARY
|
|
- ITEM
|
|
- IDENTITY_SUMMARY
|
|
example: ITEM
|
|
required:
|
|
- id
|
|
- type
|
|
RemediationItems:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The ID of the certification
|
|
example: 2c9180835d2e5168015d32f890ca1581
|
|
targetId:
|
|
type: string
|
|
description: The ID of the certification target
|
|
example: 2c9180835d2e5168015d32f890ca1581
|
|
targetName:
|
|
type: string
|
|
description: The name of the certification target
|
|
example: john.smith
|
|
targetDisplayName:
|
|
type: string
|
|
description: The display name of the certification target
|
|
example: emailAddress
|
|
applicationName:
|
|
type: string
|
|
description: The name of the application/source
|
|
example: Active Directory
|
|
attributeName:
|
|
type: string
|
|
description: The name of the attribute being certified
|
|
example: phoneNumber
|
|
attributeOperation:
|
|
type: string
|
|
description: The operation of the certification on the attribute
|
|
example: update
|
|
attributeValue:
|
|
type: string
|
|
description: The value of the attribute being certified
|
|
example: 512-555-1212
|
|
nativeIdentity:
|
|
type: string
|
|
description: The native identity of the target
|
|
example: jason.smith2
|
|
RequestableObject:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: Id of the requestable object itself
|
|
example: 2c9180835d2e5168015d32f890ca1581
|
|
name:
|
|
type: string
|
|
description: Human-readable display name of the requestable object
|
|
example: Applied Research Access
|
|
created:
|
|
type: string
|
|
format: date-time
|
|
example: '2017-07-11T18:45:37.098Z'
|
|
description: The time when the requestable object was created
|
|
modified:
|
|
nullable: true
|
|
type: string
|
|
format: date-time
|
|
example: '2018-06-25T20:22:28.104Z'
|
|
description: The time when the requestable object was last modified
|
|
description:
|
|
type: string
|
|
description: Description of the requestable object.
|
|
example: Access to research information, lab results, and schematics.
|
|
nullable: true
|
|
type:
|
|
type: string
|
|
enum:
|
|
- ACCESS_PROFILE
|
|
- ROLE
|
|
- ENTITLEMENT
|
|
description: 'The currently supported requestable object types. '
|
|
example: ACCESS_PROFILE
|
|
requestStatus:
|
|
allOf:
|
|
- type: string
|
|
enum:
|
|
- AVAILABLE
|
|
- PENDING
|
|
- ASSIGNED
|
|
- null
|
|
description: Status indicating the ability of an access request for the object to be made by or on behalf of the identity specified by *identity-id*. *AVAILABLE* indicates the object is available to request. *PENDING* indicates the object is unavailable because the identity has a pending request in flight. *ASSIGNED* indicates the object is unavailable because the identity already has the indicated role or access profile. If *identity-id* is not specified (allowed only for admin users), then status will be *AVAILABLE* for all results.
|
|
example: AVAILABLE
|
|
- nullable: true
|
|
identityRequestId:
|
|
type: string
|
|
description: If *requestStatus* is *PENDING*, indicates the id of the associated account activity.
|
|
nullable: true
|
|
example: null
|
|
ownerRef:
|
|
type: object
|
|
nullable: true
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: The type can only be IDENTITY. This is read-only.
|
|
example: IDENTITY
|
|
id:
|
|
type: string
|
|
description: Identity ID.
|
|
example: 5168015d32f890ca15812c9180835d2e
|
|
name:
|
|
type: string
|
|
description: Identity's human-readable display name. This is read-only.
|
|
example: Alison Ferguso
|
|
email:
|
|
type: string
|
|
description: Identity's email address. This is read-only.
|
|
example: alison.ferguso@identitysoon.com
|
|
requestCommentsRequired:
|
|
type: boolean
|
|
description: Whether the requester must provide comments when requesting the object.
|
|
example: false
|
|
RequestableObjectType:
|
|
type: string
|
|
enum:
|
|
- ACCESS_PROFILE
|
|
- ROLE
|
|
- ENTITLEMENT
|
|
description: 'The currently supported requestable object types. '
|
|
example: ACCESS_PROFILE
|
|
RequestableObjectRequestStatus:
|
|
type: string
|
|
enum:
|
|
- AVAILABLE
|
|
- PENDING
|
|
- ASSIGNED
|
|
- null
|
|
description: Status indicating the ability of an access request for the object to be made by or on behalf of the identity specified by *identity-id*. *AVAILABLE* indicates the object is available to request. *PENDING* indicates the object is unavailable because the identity has a pending request in flight. *ASSIGNED* indicates the object is unavailable because the identity already has the indicated role or access profile. If *identity-id* is not specified (allowed only for admin users), then status will be *AVAILABLE* for all results.
|
|
example: AVAILABLE
|
|
Reviewer:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The id of the reviewer.
|
|
example: ef38f94347e94562b5bb8424a56397d8
|
|
name:
|
|
type: string
|
|
description: The name of the reviewer.
|
|
example: Reviewer Name
|
|
email:
|
|
type: string
|
|
description: The email of the reviewing identity.
|
|
example: reviewer@test.com
|
|
type:
|
|
type: string
|
|
enum:
|
|
- IDENTITY
|
|
description: The type of the reviewing identity.
|
|
example: IDENTITY
|
|
created:
|
|
nullable: true
|
|
example: '2018-06-25T20:22:28.104Z'
|
|
format: date-time
|
|
type: string
|
|
description: The created date of the reviewing identity.
|
|
modified:
|
|
nullable: true
|
|
example: '2018-06-25T20:22:28.104Z'
|
|
format: date-time
|
|
type: string
|
|
description: The modified date of the reviewing identity.
|
|
RoleDocument:
|
|
description: Role
|
|
allOf:
|
|
- $ref: '#/components/schemas/AccountActivitySearchedItem/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/BaseDocument.yaml
|
|
- $ref: '#/components/schemas/AccessProfileDocument/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/access/BaseAccess.yaml
|
|
- type: object
|
|
properties:
|
|
accessProfiles:
|
|
type: array
|
|
description: Access profiles included with the role.
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
example: 2c91809c6faade77016fb4f0b63407ae
|
|
description: Access profile's unique ID.
|
|
name:
|
|
type: string
|
|
example: Admin Access
|
|
description: Access profile's display name.
|
|
accessProfileCount:
|
|
type: integer
|
|
description: Number of access profiles included with the role.
|
|
format: int32
|
|
example: 1
|
|
tags:
|
|
$ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/tags'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/Tags.yaml
|
|
segments:
|
|
type: array
|
|
description: Segments with the role.
|
|
items:
|
|
$ref: '#/components/schemas/EntitlementDocument/allOf/1/properties/segments/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/BaseSegment.yaml
|
|
segmentCount:
|
|
type: integer
|
|
description: Number of segments with the role.
|
|
format: int32
|
|
example: 1
|
|
entitlements:
|
|
type: array
|
|
description: Entitlements included with the role.
|
|
items:
|
|
$ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/entitlements/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/entitlement/BaseEntitlement.yaml
|
|
entitlementCount:
|
|
type: integer
|
|
description: Number of entitlements included with the role.
|
|
format: int32
|
|
example: 3
|
|
RoleSummary:
|
|
description: Role
|
|
allOf:
|
|
- $ref: '#/components/schemas/AccessProfileSummary/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/access/Access.yaml
|
|
- type: object
|
|
properties:
|
|
owner:
|
|
$ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/owner'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/DisplayReference.yaml
|
|
disabled:
|
|
type: boolean
|
|
revocable:
|
|
type: boolean
|
|
SearchDocument:
|
|
type: object
|
|
oneOf:
|
|
- description: 'More complete representation of an access profile. '
|
|
allOf:
|
|
- $ref: '#/components/schemas/AccessProfileDocument/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/access/BaseAccess.yaml
|
|
- type: object
|
|
required:
|
|
- id
|
|
- name
|
|
- _type
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: Access profile's ID.
|
|
example: 2c9180825a6c1adc015a71c9023f0818
|
|
name:
|
|
type: string
|
|
description: Access profile's name.
|
|
example: Cloud Eng
|
|
_type:
|
|
description: |-
|
|
Access profile's document type.
|
|
This enum represents the currently supported document types.
|
|
Additional values may be added in the future without notice.
|
|
type: string
|
|
enum:
|
|
- accessprofile
|
|
- accountactivity
|
|
- account
|
|
- aggregation
|
|
- entitlement
|
|
- event
|
|
- identity
|
|
- role
|
|
example: accessprofile
|
|
source:
|
|
type: object
|
|
description: Access profile's source.
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: Source's ID.
|
|
example: ff8081815757d4fb0157588f3d9d008f
|
|
name:
|
|
type: string
|
|
description: Source's name.
|
|
example: Employees
|
|
entitlements:
|
|
type: array
|
|
description: Entitlements the access profile has access to.
|
|
items:
|
|
$ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/entitlements/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/entitlement/BaseEntitlement.yaml
|
|
entitlementCount:
|
|
type: integer
|
|
description: Number of entitlements.
|
|
example: 5
|
|
tags:
|
|
$ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/tags'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/Tags.yaml
|
|
- description: AccountActivity
|
|
allOf:
|
|
- $ref: '#/components/schemas/AccountActivitySearchedItem/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/BaseDocument.yaml
|
|
- type: object
|
|
properties:
|
|
action:
|
|
type: string
|
|
description: Type of action performed in the activity.
|
|
externalDocs:
|
|
description: Learn more about account activity action types
|
|
url: https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data
|
|
example: Identity Refresh.
|
|
created:
|
|
type: string
|
|
description: ISO-8601 date-time referring to the time when the object was created.
|
|
nullable: true
|
|
format: date-time
|
|
example: '2018-06-25T20:22:28.104Z'
|
|
modified:
|
|
type: string
|
|
description: ISO-8601 date-time referring to the time when the object was last modified.
|
|
nullable: true
|
|
format: date-time
|
|
example: '2018-06-25T20:22:28.104Z'
|
|
stage:
|
|
type: string
|
|
description: Activity's current stage.
|
|
example: Completed
|
|
origin:
|
|
type: string
|
|
description: Activity's origin.
|
|
nullable: true
|
|
example: null
|
|
status:
|
|
type: string
|
|
description: Activity's current status.
|
|
example: Complete
|
|
requester:
|
|
$ref: '#/components/schemas/AccountActivitySearchedItem/allOf/1/properties/requester'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/account/AccountSource.yaml
|
|
recipient:
|
|
$ref: '#/components/schemas/AccountActivitySearchedItem/allOf/1/properties/requester'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/account/AccountSource.yaml
|
|
trackingNumber:
|
|
type: string
|
|
description: Account activity's tracking number.
|
|
example: 61aad0c9e8134eca89e76a35e0cabe3f
|
|
errors:
|
|
type: array
|
|
description: Errors provided by the source while completing account actions.
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
example: null
|
|
warnings:
|
|
type: array
|
|
description: Warnings provided by the source while completing account actions.
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
example: null
|
|
approvals:
|
|
type: array
|
|
description: Approvals performed on an item during activity.
|
|
items:
|
|
$ref: '#/components/schemas/AccountActivitySearchedItem/allOf/1/properties/approvals/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/account/activity/Approval.yaml
|
|
originalRequests:
|
|
type: array
|
|
description: Original actions that triggered all individual source actions related to the account action.
|
|
items:
|
|
$ref: '#/components/schemas/AccountActivitySearchedItem/allOf/1/properties/originalRequests/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/account/activity/OriginalRequest.yaml
|
|
expansionItems:
|
|
type: array
|
|
description: Controls that translated the attribute requests into actual provisioning actions on the source.
|
|
items:
|
|
$ref: '#/components/schemas/AccountActivitySearchedItem/allOf/1/properties/expansionItems/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/account/activity/ExpansionItem.yaml
|
|
accountRequests:
|
|
type: array
|
|
description: Account data for each individual source action triggered by the original requests.
|
|
items:
|
|
$ref: '#/components/schemas/AccountActivitySearchedItem/allOf/1/properties/accountRequests/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/account/activity/AccountRequest.yaml
|
|
sources:
|
|
type: string
|
|
description: Sources involved in the account activity.
|
|
example: smartsheet-test, airtable-v4, IdentityNow
|
|
- description: Entitlement
|
|
allOf:
|
|
- $ref: '#/components/schemas/AccountActivitySearchedItem/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/BaseDocument.yaml
|
|
- type: object
|
|
properties:
|
|
modified:
|
|
type: string
|
|
description: ISO-8601 date-time referring to the time when the object was last modified.
|
|
nullable: true
|
|
format: date-time
|
|
example: '2018-06-25T20:22:28.104Z'
|
|
synced:
|
|
type: string
|
|
description: |-
|
|
ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API.
|
|
This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database.
|
|
There may be some delay between the `synced` time and the time when the updated data is actually available in the search API.
|
|
displayName:
|
|
type: string
|
|
description: Entitlement's display name.
|
|
example: Admin
|
|
source:
|
|
type: object
|
|
description: Entitlement's source.
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: ID of entitlement's source.
|
|
example: 2c91808b6e9e6fb8016eec1a2b6f7b5f
|
|
name:
|
|
type: string
|
|
description: Display name of entitlement's source.
|
|
example: ODS-HR-Employees
|
|
segments:
|
|
type: array
|
|
description: Segments with the role.
|
|
items:
|
|
$ref: '#/components/schemas/EntitlementDocument/allOf/1/properties/segments/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/BaseSegment.yaml
|
|
segmentCount:
|
|
type: integer
|
|
description: Number of segments with the role.
|
|
format: int32
|
|
example: 1
|
|
requestable:
|
|
type: boolean
|
|
description: Indicates whether the entitlement is requestable.
|
|
default: false
|
|
example: false
|
|
cloudGoverned:
|
|
type: boolean
|
|
description: Indicates whether the entitlement is cloud governed.
|
|
default: false
|
|
example: false
|
|
created:
|
|
type: string
|
|
description: ISO-8601 date-time referring to the time when the object was created.
|
|
nullable: true
|
|
format: date-time
|
|
example: '2018-06-25T20:22:28.104Z'
|
|
privileged:
|
|
type: boolean
|
|
description: Indicates whether the entitlement is privileged.
|
|
default: false
|
|
example: false
|
|
identityCount:
|
|
type: integer
|
|
description: Number of identities who have access to the entitlement.
|
|
format: int32
|
|
example: 3
|
|
tags:
|
|
$ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/tags'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/Tags.yaml
|
|
- description: Event
|
|
allOf:
|
|
- $ref: '#/components/schemas/AccountActivitySearchedItem/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/BaseDocument.yaml
|
|
- type: object
|
|
properties:
|
|
created:
|
|
type: string
|
|
description: ISO-8601 date-time referring to the time when the object was created.
|
|
nullable: true
|
|
format: date-time
|
|
example: '2018-06-25T20:22:28.104Z'
|
|
synced:
|
|
type: string
|
|
description: |-
|
|
ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API.
|
|
This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database.
|
|
There may be some delay between the `synced` time and the time when the updated data is actually available in the search API.
|
|
action:
|
|
type: string
|
|
description: Name of the event as it's displayed in audit reports.
|
|
example: update
|
|
type:
|
|
type: string
|
|
description: Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings.
|
|
example: SYSTEM_CONFIG
|
|
actor:
|
|
type: string
|
|
description: Name of the actor that generated the event.
|
|
example: System
|
|
target:
|
|
type: string
|
|
description: Name of the target, or recipient, of the event.
|
|
example: Carol.Adams
|
|
stack:
|
|
type: string
|
|
description: The event's stack.
|
|
example: tpe
|
|
trackingNumber:
|
|
type: string
|
|
description: ID of the group of events.
|
|
example: 63f891e0735f4cc8bf1968144a1e7440
|
|
ipAddress:
|
|
type: string
|
|
description: Target system's IP address.
|
|
example: 52.52.97.85
|
|
details:
|
|
type: string
|
|
description: ID of event's details.
|
|
example: 73b65dfbed1842548c207432a18c84b0
|
|
attributes:
|
|
type: object
|
|
description: Attributes involved in the event.
|
|
additionalProperties: true
|
|
example:
|
|
pod: stg03-useast1
|
|
org: acme
|
|
sourceName: SailPoint
|
|
objects:
|
|
type: array
|
|
description: Objects the event is happening to.
|
|
items:
|
|
type: string
|
|
example: AUTHENTICATION
|
|
operation:
|
|
type: string
|
|
description: Operation, or action, performed during the event.
|
|
example: REQUEST
|
|
status:
|
|
type: string
|
|
description: Event status. Refer to [Event Statuses](https://documentation.sailpoint.com/saas/help/search/index.html#event-statuses) for a list of event statuses and their meanings.
|
|
example: PASSED
|
|
technicalName:
|
|
type: string
|
|
description: Event's normalized name. This normalized name always follows the pattern of 'objects_operation_status'.
|
|
example: AUTHENTICATION_REQUEST_PASSED
|
|
- description: Identity
|
|
allOf:
|
|
- $ref: '#/components/schemas/AccountActivitySearchedItem/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/BaseDocument.yaml
|
|
- $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/owner'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/DisplayReference.yaml
|
|
- type: object
|
|
properties:
|
|
displayName:
|
|
type: string
|
|
example: Carol.Adams
|
|
description: Identity's display name.
|
|
firstName:
|
|
type: string
|
|
description: Identity's first name.
|
|
example: Carol
|
|
lastName:
|
|
type: string
|
|
description: Identity's last name.
|
|
example: Adams
|
|
email:
|
|
type: string
|
|
description: Identity's primary email address.
|
|
example: Carol.Adams@sailpointdemo.com
|
|
created:
|
|
type: string
|
|
description: ISO-8601 date-time referring to the time when the object was created.
|
|
nullable: true
|
|
format: date-time
|
|
example: '2018-06-25T20:22:28.104Z'
|
|
modified:
|
|
type: string
|
|
description: ISO-8601 date-time referring to the time when the object was last modified.
|
|
nullable: true
|
|
format: date-time
|
|
example: '2018-06-25T20:22:28.104Z'
|
|
phone:
|
|
type: string
|
|
description: Identity's phone number.
|
|
example: +1 440-527-3672
|
|
synced:
|
|
type: string
|
|
description: |-
|
|
ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API.
|
|
This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database.
|
|
There may be some delay between the `synced` time and the time when the updated data is actually available in the search API.
|
|
inactive:
|
|
type: boolean
|
|
description: Indicates whether the identity is inactive.
|
|
default: false
|
|
example: false
|
|
protected:
|
|
type: boolean
|
|
description: Indicates whether the identity is protected.
|
|
default: false
|
|
example: false
|
|
status:
|
|
type: string
|
|
description: Identity's status in SailPoint.
|
|
example: UNREGISTERED
|
|
employeeNumber:
|
|
type: string
|
|
description: Identity's employee number.
|
|
example: 1a2a3d4e
|
|
manager:
|
|
type: object
|
|
description: Identity's manager.
|
|
nullable: true
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: ID of identity's manager.
|
|
example: 2c9180867dfe694b017e208e27c05799
|
|
name:
|
|
type: string
|
|
description: Name of identity's manager.
|
|
example: Amanda.Ross
|
|
displayName:
|
|
type: string
|
|
description: Display name of identity's manager.
|
|
example: Amanda.Ross
|
|
isManager:
|
|
type: boolean
|
|
description: Indicates whether the identity is a manager of other identities.
|
|
example: false
|
|
identityProfile:
|
|
type: object
|
|
description: Identity's identity profile.
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: Identity profile's ID.
|
|
example: 3bc8ad26b8664945866b31339d1ff7d2
|
|
name:
|
|
type: string
|
|
description: Identity profile's name.
|
|
example: HR Employees
|
|
source:
|
|
type: object
|
|
description: Identity's source.
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: ID of identity's source.
|
|
example: 2c91808b6e9e6fb8016eec1a2b6f7b5f
|
|
name:
|
|
type: string
|
|
description: Display name of identity's source.
|
|
example: ODS-HR-Employees
|
|
attributes:
|
|
type: object
|
|
description: Map or dictionary of key/value pairs.
|
|
additionalProperties: true
|
|
example:
|
|
country: US
|
|
firstname: Carol
|
|
cloudStatus: UNREGISTERED
|
|
processingState:
|
|
type: string
|
|
description: Identity's processing state.
|
|
nullable: true
|
|
example: null
|
|
processingDetails:
|
|
$ref: '#/components/schemas/IdentityDocument/allOf/2/properties/processingDetails'
|
|
description: Identity's processing details.
|
|
nullable: true
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/identity/ProcessingDetails.yaml
|
|
accounts:
|
|
type: array
|
|
description: List of accounts associated with the identity.
|
|
items:
|
|
$ref: '#/components/schemas/IdentityDocument/allOf/2/properties/accounts/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/account/BaseAccount.yaml
|
|
accountCount:
|
|
type: integer
|
|
description: Number of accounts associated with the identity.
|
|
format: int32
|
|
example: 3
|
|
apps:
|
|
type: array
|
|
description: List of applications the identity has access to.
|
|
items:
|
|
$ref: '#/components/schemas/IdentityDocument/allOf/2/properties/apps/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/identity/App.yaml
|
|
appCount:
|
|
type: integer
|
|
format: int32
|
|
description: Number of applications the identity has access to.
|
|
example: 2
|
|
access:
|
|
type: array
|
|
description: List of access items assigned to the identity.
|
|
items:
|
|
$ref: '#/components/schemas/IdentityDocument/allOf/2/properties/access/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/identity/IdentityAccess.yaml
|
|
accessCount:
|
|
type: integer
|
|
format: int32
|
|
description: Number of access items assigned to the identity.
|
|
example: 5
|
|
entitlementCount:
|
|
type: integer
|
|
format: int32
|
|
description: Number of entitlements assigned to the identity.
|
|
example: 10
|
|
roleCount:
|
|
type: integer
|
|
format: int32
|
|
description: Number of roles assigned to the identity.
|
|
example: 1
|
|
accessProfileCount:
|
|
type: integer
|
|
format: int32
|
|
description: Number of access profiles assigned to the identity.
|
|
example: 1
|
|
owns:
|
|
type: array
|
|
description: Access items the identity owns.
|
|
items:
|
|
$ref: '#/components/schemas/IdentityDocument/allOf/2/properties/owns/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/identity/Owns.yaml
|
|
ownsCount:
|
|
type: integer
|
|
format: int32
|
|
description: Number of access items the identity owns.
|
|
example: 5
|
|
tags:
|
|
$ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/tags'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/Tags.yaml
|
|
- description: Role
|
|
allOf:
|
|
- $ref: '#/components/schemas/AccountActivitySearchedItem/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/BaseDocument.yaml
|
|
- $ref: '#/components/schemas/AccessProfileDocument/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/access/BaseAccess.yaml
|
|
- type: object
|
|
properties:
|
|
accessProfiles:
|
|
type: array
|
|
description: Access profiles included with the role.
|
|
items:
|
|
$ref: '#/components/schemas/RoleDocument/allOf/2/properties/accessProfiles/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/BaseAccessProfile.yaml
|
|
accessProfileCount:
|
|
type: integer
|
|
description: Number of access profiles included with the role.
|
|
format: int32
|
|
example: 1
|
|
tags:
|
|
$ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/tags'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/Tags.yaml
|
|
segments:
|
|
type: array
|
|
description: Segments with the role.
|
|
items:
|
|
$ref: '#/components/schemas/EntitlementDocument/allOf/1/properties/segments/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/BaseSegment.yaml
|
|
segmentCount:
|
|
type: integer
|
|
description: Number of segments with the role.
|
|
format: int32
|
|
example: 1
|
|
entitlements:
|
|
type: array
|
|
description: Entitlements included with the role.
|
|
items:
|
|
$ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/entitlements/items'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/entitlement/BaseEntitlement.yaml
|
|
entitlementCount:
|
|
type: integer
|
|
description: Number of entitlements included with the role.
|
|
format: int32
|
|
example: 3
|
|
SavedSearch:
|
|
type: object
|
|
allOf:
|
|
- type: object
|
|
properties:
|
|
id:
|
|
description: |
|
|
The saved search ID.
|
|
type: string
|
|
example: 0de46054-fe90-434a-b84e-c6b3359d0c64
|
|
owner:
|
|
type: object
|
|
description: |
|
|
A typed reference to the object.
|
|
properties:
|
|
type:
|
|
$ref: '#/components/schemas/AccessProfileSummary/allOf/0/allOf/1/properties/type'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/DtoType.yaml
|
|
id:
|
|
description: |
|
|
The id of the object.
|
|
type: string
|
|
example: 2c91808568c529c60168cca6f90c1313
|
|
required:
|
|
- type
|
|
- id
|
|
ownerId:
|
|
type: string
|
|
description: The ID of the identity that owns this saved search.
|
|
example: 2c91808568c529c60168cca6f90c1313
|
|
public:
|
|
type: boolean
|
|
description: Whether this saved search is visible to anyone but the owner. This field will always be false as there is no way to set a saved search as public at this time.
|
|
default: false
|
|
example: false
|
|
- type: object
|
|
properties:
|
|
name:
|
|
description: |
|
|
The name of the saved search.
|
|
type: string
|
|
example: Disabled accounts
|
|
description:
|
|
description: |
|
|
The description of the saved search.
|
|
type: string
|
|
nullable: true
|
|
example: Disabled accounts
|
|
- type: object
|
|
properties:
|
|
created:
|
|
description: |
|
|
The date the saved search was initially created.
|
|
$ref: '#/components/schemas/Schedule/properties/expiration'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/DateTime.yaml
|
|
modified:
|
|
description: |
|
|
The last date the saved search was modified.
|
|
$ref: '#/components/schemas/Schedule/properties/expiration'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/DateTime.yaml
|
|
indices:
|
|
description: |
|
|
The names of the Elasticsearch indices in which to search.
|
|
type: array
|
|
items:
|
|
description: |-
|
|
Enum representing the currently supported indices.
|
|
Additional values may be added in the future without notice.
|
|
type: string
|
|
enum:
|
|
- accessprofiles
|
|
- accountactivities
|
|
- entitlements
|
|
- events
|
|
- identities
|
|
- roles
|
|
- '*'
|
|
example: identities
|
|
example:
|
|
- identities
|
|
columns:
|
|
description: |
|
|
The columns to be returned (specifies the order in which they will be presented) for each document type.
|
|
|
|
The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_.
|
|
type: object
|
|
additionalProperties:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
field:
|
|
description: |
|
|
The name of the field.
|
|
type: string
|
|
example: email
|
|
header:
|
|
description: |
|
|
The value of the header.
|
|
type: string
|
|
example: Work Email
|
|
required:
|
|
- field
|
|
example:
|
|
identity:
|
|
- field: displayName
|
|
header: Display Name
|
|
- field: e-mail
|
|
header: Work Email
|
|
query:
|
|
description: |
|
|
The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL.
|
|
type: string
|
|
example: '@accounts(disabled:true)'
|
|
fields:
|
|
description: |
|
|
The fields to be searched against in a multi-field query.
|
|
type: array
|
|
nullable: true
|
|
items:
|
|
type: string
|
|
example:
|
|
- disabled
|
|
orderBy:
|
|
description: |
|
|
Sort by index. This takes precedence over the `sort` property.
|
|
type: object
|
|
additionalProperties:
|
|
type: array
|
|
items:
|
|
type: string
|
|
nullable: true
|
|
example:
|
|
identity:
|
|
- lastName
|
|
- firstName
|
|
role:
|
|
- name
|
|
sort:
|
|
description: |
|
|
The fields to be used to sort the search results.
|
|
type: array
|
|
items:
|
|
type: string
|
|
example:
|
|
- displayName
|
|
nullable: true
|
|
filters:
|
|
nullable: true
|
|
allOf:
|
|
- type: object
|
|
description: The filters to be applied for each filtered field name.
|
|
example:
|
|
attributes.cloudAuthoritativeSource:
|
|
type: EXISTS
|
|
exclude: true
|
|
accessCount:
|
|
type: RANGE
|
|
range:
|
|
lower:
|
|
value: '3'
|
|
created:
|
|
type: RANGE
|
|
range:
|
|
lower:
|
|
value: '2019-12-01'
|
|
inclusive: true
|
|
upper:
|
|
value: '2020-01-01'
|
|
source.name:
|
|
type: TERMS
|
|
terms:
|
|
- HR Employees
|
|
- Corporate Active Directory
|
|
exclude: true
|
|
protected:
|
|
type: TERMS
|
|
terms:
|
|
- 'true'
|
|
- type: object
|
|
properties:
|
|
type:
|
|
description: |-
|
|
Enum representing the currently supported filter types.
|
|
Additional values may be added in the future without notice.
|
|
type: string
|
|
enum:
|
|
- EXISTS
|
|
- RANGE
|
|
- TERMS
|
|
example: RANGE
|
|
range:
|
|
type: object
|
|
description: The range of values to be filtered.
|
|
properties:
|
|
lower:
|
|
type: object
|
|
required:
|
|
- value
|
|
properties:
|
|
value:
|
|
description: The value of the range's endpoint.
|
|
type: string
|
|
example: '1'
|
|
inclusive:
|
|
description: Indicates if the endpoint is included in the range.
|
|
type: boolean
|
|
default: false
|
|
example: false
|
|
upper:
|
|
$ref: '#/components/schemas/SavedSearch/allOf/2/properties/filters/allOf/1/properties/range/properties/lower'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/filter/Bound.yaml
|
|
terms:
|
|
description: The terms to be filtered.
|
|
type: array
|
|
items:
|
|
type: string
|
|
example: account_count
|
|
exclude:
|
|
description: Indicates if the filter excludes results.
|
|
type: boolean
|
|
default: false
|
|
example: false
|
|
required:
|
|
- indices
|
|
- query
|
|
Schedule:
|
|
type: object
|
|
description: The schedule information.
|
|
properties:
|
|
type:
|
|
description: |
|
|
Enum representing the currently supported schedule types.
|
|
|
|
Additional values may be added in the future without notice.
|
|
type: string
|
|
enum:
|
|
- DAILY
|
|
- WEEKLY
|
|
- MONTHLY
|
|
- CALENDAR
|
|
- ANNUALLY
|
|
example: WEEKLY
|
|
months:
|
|
allOf:
|
|
- type: object
|
|
properties:
|
|
type:
|
|
description: |
|
|
Enum representing the currently supported selector types.
|
|
|
|
LIST - the *values* array contains one or more distinct values.
|
|
|
|
RANGE - the *values* array contains two values: the start and end of the range, inclusive.
|
|
|
|
Additional values may be added in the future without notice.
|
|
type: string
|
|
enum:
|
|
- LIST
|
|
- RANGE
|
|
example: LIST
|
|
values:
|
|
description: |
|
|
The selected values.
|
|
type: array
|
|
items:
|
|
type: string
|
|
example:
|
|
- MON
|
|
- WED
|
|
interval:
|
|
nullable: true
|
|
description: |
|
|
The selected interval for RANGE selectors.
|
|
type: integer
|
|
format: int32
|
|
example: 3
|
|
required:
|
|
- type
|
|
- values
|
|
- description: |
|
|
The months to execute the search. This only applies to schedules with a type of `ANNUALLY`.
|
|
example:
|
|
type: LIST
|
|
values:
|
|
- '3'
|
|
- '6'
|
|
- '9'
|
|
- '12'
|
|
nullable: true
|
|
days:
|
|
allOf:
|
|
- $ref: '#/components/schemas/Schedule/properties/months/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/schedule/Selector.yaml
|
|
- description: |
|
|
The days to execute the search.
|
|
|
|
If `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`.
|
|
|
|
If `type` is `MONTHLY` or `ANNUALLY`, the values will be a number in double quotes, like `"1"`, `"10"`, or `"28"`. Optionally, the value `"L"` can be used to refer to the last day of the month.
|
|
example:
|
|
type: LIST
|
|
values:
|
|
- MON
|
|
- WED
|
|
- FRI
|
|
nullable: true
|
|
hours:
|
|
allOf:
|
|
- $ref: '#/components/schemas/Schedule/properties/months/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/schedule/Selector.yaml
|
|
- description: The hours selected.
|
|
example:
|
|
type: RANGE
|
|
values:
|
|
- '9'
|
|
- '18'
|
|
interval: 3
|
|
expiration:
|
|
type: string
|
|
nullable: true
|
|
format: date-time
|
|
example: '2018-06-25T20:22:28.104Z'
|
|
description: A date-time in ISO-8601 format
|
|
timeZoneId:
|
|
description: The canonical TZ identifier the schedule will run in (ex. America/New_York). If no timezone is specified, the org's default timezone is used.
|
|
nullable: true
|
|
type: string
|
|
example: America/Chicago
|
|
required:
|
|
- type
|
|
- hours
|
|
ScheduledSearch:
|
|
type: object
|
|
allOf:
|
|
- type: object
|
|
properties:
|
|
id:
|
|
description: The scheduled search ID.
|
|
type: string
|
|
example: 0de46054-fe90-434a-b84e-c6b3359d0c64
|
|
readOnly: true
|
|
owner:
|
|
description: The owner of the scheduled search
|
|
readOnly: true
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: The type of object being referenced
|
|
enum:
|
|
- IDENTITY
|
|
example: IDENTITY
|
|
id:
|
|
type: string
|
|
description: The ID of the referenced object
|
|
example: 2c9180867624cbd7017642d8c8c81f67
|
|
required:
|
|
- type
|
|
- id
|
|
ownerId:
|
|
description: |
|
|
The ID of the scheduled search owner.
|
|
|
|
Please use the `id` in the `owner` object instead.
|
|
type: string
|
|
example: 2c9180867624cbd7017642d8c8c81f67
|
|
readOnly: true
|
|
deprecated: true
|
|
- type: object
|
|
properties:
|
|
name:
|
|
description: |
|
|
The name of the scheduled search.
|
|
type: string
|
|
example: Daily disabled accounts
|
|
nullable: true
|
|
description:
|
|
description: |
|
|
The description of the scheduled search.
|
|
type: string
|
|
nullable: true
|
|
example: Daily disabled accounts
|
|
- type: object
|
|
properties:
|
|
savedSearchId:
|
|
description: The ID of the saved search that will be executed.
|
|
type: string
|
|
example: 554f1511-f0a1-4744-ab14-599514d3e57c
|
|
created:
|
|
allOf:
|
|
- $ref: '#/components/schemas/Schedule/properties/expiration'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/DateTime.yaml
|
|
description: The date the scheduled search was initially created.
|
|
readOnly: true
|
|
modified:
|
|
allOf:
|
|
- $ref: '#/components/schemas/Schedule/properties/expiration'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/DateTime.yaml
|
|
description: The last date the scheduled search was modified.
|
|
readOnly: true
|
|
schedule:
|
|
type: object
|
|
description: The schedule information.
|
|
properties:
|
|
type:
|
|
$ref: '#/components/schemas/Schedule/properties/type'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/schedule/ScheduleType.yaml
|
|
months:
|
|
allOf:
|
|
- $ref: '#/components/schemas/Schedule/properties/months/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/schedule/Selector.yaml
|
|
- description: |
|
|
The months to execute the search. This only applies to schedules with a type of `ANNUALLY`.
|
|
example:
|
|
type: LIST
|
|
values:
|
|
- '3'
|
|
- '6'
|
|
- '9'
|
|
- '12'
|
|
nullable: true
|
|
days:
|
|
allOf:
|
|
- $ref: '#/components/schemas/Schedule/properties/months/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/schedule/Selector.yaml
|
|
- description: |
|
|
The days to execute the search.
|
|
|
|
If `type` is `WEEKLY`, the values will be `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, and `SUN`.
|
|
|
|
If `type` is `MONTHLY` or `ANNUALLY`, the values will be a number in double quotes, like `"1"`, `"10"`, or `"28"`. Optionally, the value `"L"` can be used to refer to the last day of the month.
|
|
example:
|
|
type: LIST
|
|
values:
|
|
- MON
|
|
- WED
|
|
- FRI
|
|
nullable: true
|
|
hours:
|
|
allOf:
|
|
- $ref: '#/components/schemas/Schedule/properties/months/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/schedule/Selector.yaml
|
|
- description: The hours selected.
|
|
example:
|
|
type: RANGE
|
|
values:
|
|
- '9'
|
|
- '18'
|
|
interval: 3
|
|
expiration:
|
|
description: The schedule expiration date. Latest possible expiration date is '2038-01-19T03:14:07+0000'
|
|
$ref: '#/components/schemas/Schedule/properties/expiration'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/DateTime.yaml
|
|
timeZoneId:
|
|
description: The canonical TZ identifier the schedule will run in (ex. America/New_York). If no timezone is specified, the org's default timezone is used.
|
|
nullable: true
|
|
type: string
|
|
example: America/Chicago
|
|
required:
|
|
- type
|
|
- hours
|
|
recipients:
|
|
description: A list of identities that should receive the scheduled search report via email.
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: The type of object being referenced
|
|
enum:
|
|
- IDENTITY
|
|
example: IDENTITY
|
|
id:
|
|
type: string
|
|
description: The ID of the referenced object
|
|
example: 2c9180867624cbd7017642d8c8c81f67
|
|
required:
|
|
- type
|
|
- id
|
|
enabled:
|
|
description: |
|
|
Indicates if the scheduled search is enabled.
|
|
type: boolean
|
|
default: false
|
|
example: false
|
|
emailEmptyResults:
|
|
description: |
|
|
Indicates if email generation should occur when search returns no results.
|
|
type: boolean
|
|
default: false
|
|
example: false
|
|
displayQueryDetails:
|
|
description: |
|
|
Indicates if the generated email should include the query and search results preview (which could include PII).
|
|
type: boolean
|
|
default: false
|
|
example: false
|
|
required:
|
|
- savedSearchId
|
|
- schedule
|
|
- recipients
|
|
required:
|
|
- id
|
|
- owner
|
|
- ownerId
|
|
ServiceDeskIntegrationDto:
|
|
allOf:
|
|
- type: object
|
|
description: Service Desk integration's specification.
|
|
required:
|
|
- name
|
|
- description
|
|
- type
|
|
- attributes
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: Unique identifier for the Service Desk integration
|
|
example: 62945a496ef440189b1f03e3623411c8
|
|
name:
|
|
description: Service Desk integration's name. The name must be unique.
|
|
type: string
|
|
example: Service Desk Integration Name
|
|
created:
|
|
type: string
|
|
format: date-time
|
|
description: The date and time the Service Desk integration was created
|
|
example: '2024-01-17T18:45:25.994Z'
|
|
modified:
|
|
type: string
|
|
format: date-time
|
|
description: The date and time the Service Desk integration was last modified
|
|
example: '2024-02-18T18:45:25.994Z'
|
|
description:
|
|
description: Service Desk integration's description.
|
|
type: string
|
|
example: A very nice Service Desk integration
|
|
type:
|
|
description: |
|
|
Service Desk integration types:
|
|
|
|
- ServiceNowSDIM
|
|
- ServiceNow
|
|
type: string
|
|
default: ServiceNowSDIM
|
|
example: ServiceNowSDIM
|
|
ownerRef:
|
|
allOf:
|
|
- type: object
|
|
description: Owner's identity.
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: Owner's DTO type.
|
|
enum:
|
|
- IDENTITY
|
|
example: IDENTITY
|
|
id:
|
|
type: string
|
|
description: Owner's identity ID.
|
|
example: 2c9180a46faadee4016fb4e018c20639
|
|
name:
|
|
type: string
|
|
description: Owner's name.
|
|
example: Support
|
|
clusterRef:
|
|
allOf:
|
|
- type: object
|
|
description: Source cluster.
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: Source cluster DTO type.
|
|
enum:
|
|
- CLUSTER
|
|
example: CLUSTER
|
|
id:
|
|
type: string
|
|
description: Source cluster ID.
|
|
example: 2c9180847a7fccdd017aa5896f9f4f6f
|
|
name:
|
|
type: string
|
|
description: Source cluster display name.
|
|
example: Training VA
|
|
cluster:
|
|
description: Cluster ID for the Service Desk integration (replaced by clusterRef, retained for backward compatibility).
|
|
type: string
|
|
example: xyzzy999
|
|
deprecated: true
|
|
nullable: true
|
|
managedSources:
|
|
description: Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility).
|
|
type: array
|
|
items:
|
|
type: string
|
|
deprecated: true
|
|
example:
|
|
- 2c9180835d191a86015d28455b4a2329
|
|
- 2c5680835d191a85765d28455b4a9823
|
|
provisioningConfig:
|
|
type: object
|
|
description: Specification of a Service Desk integration provisioning configuration.
|
|
properties:
|
|
universalManager:
|
|
description: Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.
|
|
type: boolean
|
|
readOnly: true
|
|
default: false
|
|
example: true
|
|
managedResourceRefs:
|
|
description: References to sources for the Service Desk integration template. May only be specified if universalManager is false.
|
|
type: array
|
|
items:
|
|
allOf:
|
|
- $ref: '#/components/schemas/ProvisioningConfig/properties/managedResourceRefs/items/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ServiceDeskSource.yaml
|
|
example:
|
|
- type: SOURCE
|
|
id: 2c9180855d191c59015d291ceb051111
|
|
name: My Source 1
|
|
- type: SOURCE
|
|
id: 2c9180855d191c59015d291ceb052222
|
|
name: My Source 2
|
|
planInitializerScript:
|
|
description: This is a reference to a plan initializer script.
|
|
type: object
|
|
nullable: true
|
|
properties:
|
|
source:
|
|
description: This is a Rule that allows provisioning instruction changes.
|
|
type: string
|
|
example: |
|
|
<?xml version='1.0' encoding='UTF-8'?>\r\n<!DOCTYPE Rule PUBLIC \"sailpoint.dtd\" \"sailpoint.dtd\">\r\n<Rule name=\"Example Rule\" type=\"BeforeProvisioning\">\r\n <Description>Before Provisioning Rule which changes disables and enables to a modify.</Description>\r\n <Source><![CDATA[\r\nimport sailpoint.object.*;\r\nimport sailpoint.object.ProvisioningPlan.AccountRequest;\r\nimport sailpoint.object.ProvisioningPlan.AccountRequest.Operation;\r\nimport sailpoint.object.ProvisioningPlan.AttributeRequest;\r\nimport sailpoint.object.ProvisioningPlan;\r\nimport sailpoint.object.ProvisioningPlan.Operation;\r\n\r\nfor ( AccountRequest accountRequest : plan.getAccountRequests() ) {\r\n if ( accountRequest.getOp().equals( ProvisioningPlan.ObjectOperation.Disable ) ) {\r\n accountRequest.setOp( ProvisioningPlan.ObjectOperation.Modify );\r\n }\r\n if ( accountRequest.getOp().equals( ProvisioningPlan.ObjectOperation.Enable ) ) {\r\n accountRequest.setOp( ProvisioningPlan.ObjectOperation.Modify );\r\n }\r\n}\r\n\r\n ]]></Source>
|
|
noProvisioningRequests:
|
|
description: Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration.
|
|
type: boolean
|
|
default: false
|
|
example: true
|
|
provisioningRequestExpiration:
|
|
description: When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation.
|
|
type: integer
|
|
format: int32
|
|
example: 7
|
|
attributes:
|
|
description: Service Desk integration's attributes. Validation constraints enforced by the implementation.
|
|
type: object
|
|
additionalProperties: true
|
|
example:
|
|
property: value
|
|
key: value
|
|
beforeProvisioningRule:
|
|
allOf:
|
|
- type: object
|
|
description: Before Provisioning Rule.
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: Before Provisioning Rule DTO type.
|
|
enum:
|
|
- RULE
|
|
example: RULE
|
|
id:
|
|
type: string
|
|
description: Before Provisioning Rule ID.
|
|
example: 048eb3d55c5a4758bd07dccb87741c78
|
|
name:
|
|
type: string
|
|
description: Rule display name.
|
|
example: Before Provisioning Airtable Rule
|
|
ServiceDeskIntegrationTemplateDto:
|
|
allOf:
|
|
- $ref: '#/components/schemas/Account/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/BaseCommonDto.yaml
|
|
- type: object
|
|
description: This is the model for a Service Desk integration template, used to create and edit Service Desk Integrations.
|
|
required:
|
|
- type
|
|
- attributes
|
|
- provisioningConfig
|
|
properties:
|
|
type:
|
|
description: The 'type' property specifies the type of the Service Desk integration template.
|
|
type: string
|
|
example: Web Service SDIM
|
|
default: Web Service SDIM
|
|
attributes:
|
|
description: The 'attributes' property value is a map of attributes available for integrations using this Service Desk integration template.
|
|
type: object
|
|
additionalProperties: true
|
|
example:
|
|
property: value
|
|
key: value
|
|
provisioningConfig:
|
|
$ref: '#/components/schemas/ServiceDeskIntegrationDto/allOf/0/properties/provisioningConfig'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ProvisioningConfig.yaml
|
|
ServiceDeskIntegrationTemplateType:
|
|
description: This represents a Service Desk Integration template type.
|
|
required:
|
|
- type
|
|
- scriptName
|
|
type: object
|
|
properties:
|
|
name:
|
|
description: This is the name of the type.
|
|
example: aName
|
|
type: string
|
|
type:
|
|
description: This is the type value for the type.
|
|
example: aType
|
|
type: string
|
|
scriptName:
|
|
description: This is the scriptName attribute value for the type.
|
|
example: aScriptName
|
|
type: string
|
|
Source:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
readOnly: true
|
|
description: Source ID.
|
|
example: 2c91808568c529c60168cca6f90c1324
|
|
name:
|
|
type: string
|
|
description: Source's human-readable name.
|
|
example: My Source
|
|
description:
|
|
type: string
|
|
description: Source's human-readable description.
|
|
example: This is the corporate directory.
|
|
owner:
|
|
description: Reference to identity object who owns the source.
|
|
type: object
|
|
properties:
|
|
type:
|
|
description: Type of object being referenced.
|
|
type: string
|
|
enum:
|
|
- IDENTITY
|
|
example: IDENTITY
|
|
id:
|
|
type: string
|
|
description: Owner identity's ID.
|
|
example: 2c91808568c529c60168cca6f90c1313
|
|
name:
|
|
type: string
|
|
description: Owner identity's human-readable display name.
|
|
example: MyName
|
|
cluster:
|
|
description: Reference to the source's associated cluster.
|
|
type: object
|
|
nullable: true
|
|
required:
|
|
- name
|
|
- id
|
|
- type
|
|
properties:
|
|
type:
|
|
description: Type of object being referenced.
|
|
type: string
|
|
enum:
|
|
- CLUSTER
|
|
example: CLUSTER
|
|
id:
|
|
type: string
|
|
description: Cluster ID.
|
|
example: 2c9180866166b5b0016167c32ef31a66
|
|
name:
|
|
type: string
|
|
description: Cluster's human-readable display name.
|
|
example: Corporate Cluster
|
|
accountCorrelationConfig:
|
|
description: Reference to account correlation config object.
|
|
type: object
|
|
nullable: true
|
|
properties:
|
|
type:
|
|
description: Type of object being referenced.
|
|
type: string
|
|
enum:
|
|
- ACCOUNT_CORRELATION_CONFIG
|
|
example: ACCOUNT_CORRELATION_CONFIG
|
|
id:
|
|
type: string
|
|
description: Account correlation config ID.
|
|
example: 2c9180855d191c59015d28583727245a
|
|
name:
|
|
type: string
|
|
description: Account correlation config's human-readable display name.
|
|
example: Directory [source-62867] Account Correlation
|
|
accountCorrelationRule:
|
|
description: Reference to a rule that can do COMPLEX correlation. Only use this rule when you can't use accountCorrelationConfig.
|
|
type: object
|
|
nullable: true
|
|
properties:
|
|
type:
|
|
description: Type of object being referenced.
|
|
type: string
|
|
enum:
|
|
- RULE
|
|
example: RULE
|
|
id:
|
|
type: string
|
|
description: Rule ID.
|
|
example: 2c918085708c274401708c2a8a760001
|
|
name:
|
|
type: string
|
|
description: Rule's human-readable display name.
|
|
example: Example Rule
|
|
managerCorrelationMapping:
|
|
allOf:
|
|
- type: object
|
|
properties:
|
|
accountAttributeName:
|
|
type: string
|
|
description: Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity.
|
|
example: manager
|
|
identityAttributeName:
|
|
type: string
|
|
description: Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute.
|
|
example: manager
|
|
- nullable: true
|
|
description: |
|
|
Filter object used during manager correlation to match incoming manager values to an existing manager's
|
|
account/identity.
|
|
managerCorrelationRule:
|
|
description: Reference to the ManagerCorrelationRule. Only use this rule when a simple filter isn't sufficient.
|
|
type: object
|
|
nullable: true
|
|
properties:
|
|
type:
|
|
description: Type of object being referenced.
|
|
type: string
|
|
enum:
|
|
- RULE
|
|
example: RULE
|
|
id:
|
|
type: string
|
|
description: Rule ID.
|
|
example: 2c918085708c274401708c2a8a760001
|
|
name:
|
|
type: string
|
|
description: Rule's human-readable display name.
|
|
example: Example Rule
|
|
beforeProvisioningRule:
|
|
description: 'Rule that runs on the CCG and allows for customization of provisioning plans before the API calls the connector. '
|
|
type: object
|
|
nullable: true
|
|
properties:
|
|
type:
|
|
description: Type of object being referenced.
|
|
type: string
|
|
enum:
|
|
- RULE
|
|
example: RULE
|
|
id:
|
|
type: string
|
|
description: Rule ID.
|
|
example: 2c918085708c274401708c2a8a760001
|
|
name:
|
|
type: string
|
|
description: Rule's human-readable display name.
|
|
example: Example Rule
|
|
schemas:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
description: Type of object being referenced.
|
|
type: string
|
|
enum:
|
|
- CONNECTOR_SCHEMA
|
|
example: CONNECTOR_SCHEMA
|
|
id:
|
|
type: string
|
|
description: Schema ID.
|
|
example: 2c91808568c529c60168cca6f90c1777
|
|
name:
|
|
type: string
|
|
description: Schema's human-readable display name.
|
|
example: MySchema
|
|
description: List of references to schema objects.
|
|
example:
|
|
- type: CONNECTOR_SCHEMA
|
|
id: 2c9180835d191a86015d28455b4b232a
|
|
name: account
|
|
- type: CONNECTOR_SCHEMA
|
|
id: 2c9180835d191a86015d28455b4b232b
|
|
name: group
|
|
passwordPolicies:
|
|
type: array
|
|
nullable: true
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
description: Type of object being referenced.
|
|
type: string
|
|
enum:
|
|
- PASSWORD_POLICY
|
|
example: PASSWORD_POLICY
|
|
id:
|
|
type: string
|
|
description: Policy ID.
|
|
example: 2c91808568c529c60168cca6f90c1777
|
|
name:
|
|
type: string
|
|
description: Policy's human-readable display name.
|
|
example: My Password Policy
|
|
description: List of references to the associated PasswordPolicy objects.
|
|
example:
|
|
- type: PASSWORD_POLICY
|
|
id: 2c9180855d191c59015d291ceb053980
|
|
name: Corporate Password Policy
|
|
- type: PASSWORD_POLICY
|
|
id: 2c9180855d191c59015d291ceb057777
|
|
name: Vendor Password Policy
|
|
features:
|
|
type: array
|
|
items:
|
|
type: string
|
|
enum:
|
|
- AUTHENTICATE
|
|
- COMPOSITE
|
|
- DIRECT_PERMISSIONS
|
|
- DISCOVER_SCHEMA
|
|
- ENABLE
|
|
- MANAGER_LOOKUP
|
|
- NO_RANDOM_ACCESS
|
|
- PROXY
|
|
- SEARCH
|
|
- TEMPLATE
|
|
- UNLOCK
|
|
- UNSTRUCTURED_TARGETS
|
|
- SHAREPOINT_TARGET
|
|
- PROVISIONING
|
|
- GROUP_PROVISIONING
|
|
- SYNC_PROVISIONING
|
|
- PASSWORD
|
|
- CURRENT_PASSWORD
|
|
- ACCOUNT_ONLY_REQUEST
|
|
- ADDITIONAL_ACCOUNT_REQUEST
|
|
- NO_AGGREGATION
|
|
- GROUPS_HAVE_MEMBERS
|
|
- NO_PERMISSIONS_PROVISIONING
|
|
- NO_GROUP_PERMISSIONS_PROVISIONING
|
|
- NO_UNSTRUCTURED_TARGETS_PROVISIONING
|
|
- NO_DIRECT_PERMISSIONS_PROVISIONING
|
|
- PREFER_UUID
|
|
- ARM_SECURITY_EXTRACT
|
|
- ARM_UTILIZATION_EXTRACT
|
|
- ARM_CHANGELOG_EXTRACT
|
|
- USES_UUID
|
|
example: AUTHENTICATE
|
|
description: |-
|
|
Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors.
|
|
* AUTHENTICATE: The source supports pass-through authentication.
|
|
* COMPOSITE: The source supports composite source creation.
|
|
* DIRECT_PERMISSIONS: The source supports returning DirectPermissions.
|
|
* DISCOVER_SCHEMA: The source supports discovering schemas for users and groups.
|
|
* ENABLE The source supports reading if an account is enabled or disabled.
|
|
* MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS.
|
|
* NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform.
|
|
* PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source.
|
|
* SEARCH
|
|
* TEMPLATE
|
|
* UNLOCK: The source supports reading if an account is locked or unlocked.
|
|
* UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets.
|
|
* SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources.
|
|
* PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation.
|
|
* GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented.
|
|
* SYNC_PROVISIONING: The source can provision accounts synchronously.
|
|
* PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature.
|
|
* CURRENT_PASSWORD: Some source types support verification of the current password
|
|
* ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements.
|
|
* ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts.
|
|
* NO_AGGREGATION: A source that does not support aggregation.
|
|
* GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation.
|
|
* NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts.
|
|
* NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups.
|
|
* NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.
|
|
* NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.
|
|
* USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure.
|
|
* PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning.
|
|
* ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM
|
|
* ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM
|
|
* ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM
|
|
example:
|
|
- PROVISIONING
|
|
- NO_PERMISSIONS_PROVISIONING
|
|
- GROUPS_HAVE_MEMBERS
|
|
type:
|
|
type: string
|
|
description: 'Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. '
|
|
example: OpenLDAP - Direct
|
|
connector:
|
|
type: string
|
|
description: Connector script name.
|
|
example: active-directory
|
|
connectorClass:
|
|
type: string
|
|
description: Fully qualified name of the Java class that implements the connector interface.
|
|
example: sailpoint.connector.LDAPConnector
|
|
connectorAttributes:
|
|
type: object
|
|
description: Connector specific configuration. This configuration will differ from type to type.
|
|
example:
|
|
healthCheckTimeout: 30
|
|
authSearchAttributes:
|
|
- cn
|
|
- uid
|
|
- mail
|
|
deleteThreshold:
|
|
type: integer
|
|
format: int32
|
|
description: Number from 0 to 100 that specifies when to skip the delete phase.
|
|
example: 10
|
|
authoritative:
|
|
type: boolean
|
|
description: When this is true, it indicates that the source is referenced by an identity profile.
|
|
default: false
|
|
example: false
|
|
managementWorkgroup:
|
|
description: Reference to management workgroup for the source.
|
|
type: object
|
|
nullable: true
|
|
properties:
|
|
type:
|
|
description: Type of object being referenced.
|
|
type: string
|
|
enum:
|
|
- GOVERNANCE_GROUP
|
|
example: GOVERNANCE_GROUP
|
|
id:
|
|
type: string
|
|
description: Management workgroup ID.
|
|
example: 2c91808568c529c60168cca6f90c2222
|
|
name:
|
|
type: string
|
|
description: Management workgroup's human-readable display name.
|
|
example: My Management Workgroup
|
|
healthy:
|
|
type: boolean
|
|
description: When this is true, it indicates that the source is healthy.
|
|
default: false
|
|
example: true
|
|
status:
|
|
type: string
|
|
enum:
|
|
- SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT
|
|
- SOURCE_STATE_ERROR_CLUSTER
|
|
- SOURCE_STATE_ERROR_SOURCE
|
|
- SOURCE_STATE_ERROR_VA
|
|
- SOURCE_STATE_FAILURE_CLUSTER
|
|
- SOURCE_STATE_FAILURE_SOURCE
|
|
- SOURCE_STATE_HEALTHY
|
|
- SOURCE_STATE_UNCHECKED_CLUSTER
|
|
- SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES
|
|
- SOURCE_STATE_UNCHECKED_SOURCE
|
|
- SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS
|
|
description: 'Status identifier that gives specific information about why a source is or isn''t healthy. '
|
|
example: SOURCE_STATE_HEALTHY
|
|
since:
|
|
type: string
|
|
description: Timestamp that shows when a source health check was last performed.
|
|
example: '2021-09-28T15:48:29.380Z'
|
|
connectorId:
|
|
type: string
|
|
description: Connector ID
|
|
example: active-directory
|
|
connectorName:
|
|
type: string
|
|
description: Name of the connector that was chosen during source creation.
|
|
example: Active Directory
|
|
connectionType:
|
|
type: string
|
|
description: Type of connection (direct or file).
|
|
example: file
|
|
connectorImplementationId:
|
|
type: string
|
|
description: Connector implementation ID.
|
|
example: delimited-file
|
|
created:
|
|
type: string
|
|
description: Date-time when the source was created
|
|
format: date-time
|
|
example: '2022-02-08T14:50:03.827Z'
|
|
modified:
|
|
type: string
|
|
description: Date-time when the source was last modified.
|
|
format: date-time
|
|
example: '2024-01-23T18:08:50.897Z'
|
|
credentialProviderEnabled:
|
|
type: boolean
|
|
description: If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials.
|
|
default: false
|
|
example: false
|
|
category:
|
|
type: string
|
|
nullable: true
|
|
default: null
|
|
description: Source category (e.g. null, CredentialProvider).
|
|
example: CredentialProvider
|
|
required:
|
|
- name
|
|
- owner
|
|
- connector
|
|
SourceHealthDto:
|
|
type: object
|
|
description: Dto for source health data
|
|
properties:
|
|
id:
|
|
type: string
|
|
readOnly: true
|
|
description: the id of the Source
|
|
example: 2c91808568c529c60168cca6f90c1324
|
|
type:
|
|
type: string
|
|
description: 'Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. '
|
|
example: OpenLDAP - Direct
|
|
name:
|
|
type: string
|
|
description: the name of the source
|
|
example: Source1234
|
|
org:
|
|
type: string
|
|
description: source's org
|
|
example: denali-cjh
|
|
isAuthoritative:
|
|
type: boolean
|
|
example: false
|
|
description: Is the source authoritative
|
|
isCluster:
|
|
type: boolean
|
|
example: false
|
|
description: Is the source in a cluster
|
|
hostname:
|
|
type: string
|
|
example: megapod-useast1-secret-hostname.sailpoint.com
|
|
description: source's hostname
|
|
pod:
|
|
type: string
|
|
description: source's pod
|
|
example: megapod-useast1
|
|
iqServiceVersion:
|
|
type: string
|
|
description: The version of the iqService
|
|
example: iqVersion123
|
|
status:
|
|
type: string
|
|
enum:
|
|
- SOURCE_STATE_ERROR_CLUSTER
|
|
- SOURCE_STATE_ERROR_SOURCE
|
|
- SOURCE_STATE_ERROR_VA
|
|
- SOURCE_STATE_FAILURE_CLUSTER
|
|
- SOURCE_STATE_FAILURE_SOURCE
|
|
- SOURCE_STATE_HEALTHY
|
|
- SOURCE_STATE_UNCHECKED_CLUSTER
|
|
- SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES
|
|
- SOURCE_STATE_UNCHECKED_SOURCE
|
|
- SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS
|
|
description: connection test result
|
|
example: SOURCE_STATE_UNCHECKED_SOURCE
|
|
Transform:
|
|
type: object
|
|
description: The representation of an internally- or customer-defined transform.
|
|
required:
|
|
- name
|
|
- type
|
|
- attributes
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Unique name of this transform
|
|
example: Timestamp To Date
|
|
minLength: 1
|
|
maxLength: 50
|
|
type:
|
|
type: string
|
|
description: The type of transform operation
|
|
enum:
|
|
- accountAttribute
|
|
- base64Decode
|
|
- base64Encode
|
|
- concat
|
|
- conditional
|
|
- dateCompare
|
|
- dateFormat
|
|
- dateMath
|
|
- decomposeDiacriticalMarks
|
|
- e164phone
|
|
- firstValid
|
|
- rule
|
|
- identityAttribute
|
|
- indexOf
|
|
- iso3166
|
|
- lastIndexOf
|
|
- leftPad
|
|
- lookup
|
|
- lower
|
|
- normalizeNames
|
|
- randomAlphaNumeric
|
|
- randomNumeric
|
|
- reference
|
|
- replaceAll
|
|
- replace
|
|
- rightPad
|
|
- split
|
|
- static
|
|
- substring
|
|
- trim
|
|
- upper
|
|
- usernameGenerator
|
|
- uuid
|
|
- displayName
|
|
- rfc5646
|
|
example: dateFormat
|
|
externalDocs:
|
|
description: Transform Operations
|
|
url: https://developer.sailpoint.com/idn/docs/transforms/operations
|
|
attributes:
|
|
nullable: true
|
|
description: Meta-data about the transform. Values in this list are specific to the type of transform to be executed.
|
|
oneOf:
|
|
- title: accountAttribute
|
|
type: object
|
|
required:
|
|
- sourceName
|
|
- attributeName
|
|
properties:
|
|
sourceName:
|
|
type: string
|
|
description: A reference to the source to search for the account
|
|
example: Workday
|
|
attributeName:
|
|
type: string
|
|
description: The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.
|
|
example: DEPARTMENT
|
|
accountSortAttribute:
|
|
type: string
|
|
description: The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries
|
|
example: created
|
|
default: created
|
|
accountSortDescending:
|
|
type: boolean
|
|
description: The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)
|
|
example: false
|
|
default: false
|
|
accountReturnFirstLink:
|
|
type: boolean
|
|
description: The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false
|
|
example: false
|
|
default: false
|
|
accountFilter:
|
|
type: string
|
|
description: |-
|
|
This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria.
|
|
Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements
|
|
example: '!(nativeIdentity.startsWith("*DELETED*"))'
|
|
accountPropertyFilter:
|
|
type: string
|
|
description: |-
|
|
This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset.
|
|
|
|
All account attributes are available for filtering as this operation is performed in memory.
|
|
example: (groups.containsAll({'Admin'}) || location == 'Austin')
|
|
requiresPeriodicRefresh:
|
|
type: boolean
|
|
description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process
|
|
example: false
|
|
default: false
|
|
input:
|
|
type: object
|
|
description: This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI.
|
|
additionalProperties: true
|
|
example:
|
|
type: accountAttribute
|
|
attributes:
|
|
attributeName: first_name
|
|
sourceName: Source
|
|
- title: base64Decode
|
|
type: object
|
|
properties:
|
|
requiresPeriodicRefresh:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/RequiresPeriodicRefresh.yaml
|
|
input:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/input.yaml
|
|
- title: base64Encode
|
|
type: object
|
|
properties:
|
|
requiresPeriodicRefresh:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/RequiresPeriodicRefresh.yaml
|
|
input:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/input.yaml
|
|
- title: concat
|
|
type: object
|
|
required:
|
|
- values
|
|
properties:
|
|
values:
|
|
type: array
|
|
items:
|
|
type: object
|
|
description: An array of items to join together
|
|
example:
|
|
- John
|
|
- ' '
|
|
- Smith
|
|
requiresPeriodicRefresh:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/RequiresPeriodicRefresh.yaml
|
|
input:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/input.yaml
|
|
- title: conditional
|
|
type: object
|
|
required:
|
|
- expression
|
|
- positiveCondition
|
|
- negativeCondition
|
|
properties:
|
|
expression:
|
|
type: string
|
|
description: |-
|
|
A comparison statement that follows the structure of `ValueA eq ValueB` where `ValueA` and `ValueB` are static strings or outputs of other transforms.
|
|
|
|
The `eq` operator is the only valid comparison
|
|
example: ValueA eq ValueB
|
|
positiveCondition:
|
|
type: string
|
|
description: The output of the transform if the expression evalutes to true
|
|
example: 'true'
|
|
negativeCondition:
|
|
type: string
|
|
description: The output of the transform if the expression evalutes to false
|
|
example: 'false'
|
|
requiresPeriodicRefresh:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/RequiresPeriodicRefresh.yaml
|
|
input:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/input.yaml
|
|
- title: dateCompare
|
|
type: object
|
|
required:
|
|
- firstDate
|
|
- secondDate
|
|
- operator
|
|
- positiveCondition
|
|
- negativeCondition
|
|
properties:
|
|
firstDate:
|
|
description: This is the first date to consider (The date that would be on the left hand side of the comparison operation).
|
|
oneOf:
|
|
- $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/AccountAttribute.yaml
|
|
- $ref: '#/components/schemas/Transform/properties/attributes/oneOf/6'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/DateFormat.yaml
|
|
secondDate:
|
|
description: This is the second date to consider (The date that would be on the right hand side of the comparison operation).
|
|
oneOf:
|
|
- $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/AccountAttribute.yaml
|
|
- $ref: '#/components/schemas/Transform/properties/attributes/oneOf/6'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/DateFormat.yaml
|
|
operator:
|
|
type: string
|
|
description: |
|
|
This is the comparison to perform.
|
|
| Operation | Description |
|
|
| --------- | ------- |
|
|
| LT | Strictly less than: `firstDate < secondDate` |
|
|
| LTE | Less than or equal to: `firstDate <= secondDate` |
|
|
| GT | Strictly greater than: `firstDate > secondDate` |
|
|
| GTE | Greater than or equal to: `firstDate >= secondDate` |
|
|
enum:
|
|
- LT
|
|
- LTE
|
|
- GT
|
|
- GTE
|
|
example: LT
|
|
positiveCondition:
|
|
type: string
|
|
description: The output of the transform if the expression evalutes to true
|
|
example: 'true'
|
|
negativeCondition:
|
|
type: string
|
|
description: The output of the transform if the expression evalutes to false
|
|
example: false
|
|
requiresPeriodicRefresh:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/RequiresPeriodicRefresh.yaml
|
|
input:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/input.yaml
|
|
- title: dateFormat
|
|
type: object
|
|
properties:
|
|
inputFormat:
|
|
description: |-
|
|
A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as.
|
|
|
|
*If no inputFormat is provided, the transform assumes that it is in ISO8601 format*
|
|
oneOf:
|
|
- title: Named Construct
|
|
type: string
|
|
description: |
|
|
| Construct | Date Time Pattern | Description |
|
|
| --------- | ----------------- | ----------- |
|
|
| ISO8601 | `yyyy-MM-dd'T'HH:mm:ss.SSSX` | The ISO8601 standard. |
|
|
| LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. |
|
|
| PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. |
|
|
| EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. |
|
|
| EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. |
|
|
enum:
|
|
- ISO8601
|
|
- LDAP
|
|
- PEOPLE_SOFT
|
|
- EPOCH_TIME_JAVA
|
|
- EPOCH_TIME_WIN32
|
|
example: PEOPLE_SOFT
|
|
- title: Java Simple Date Format
|
|
type: string
|
|
description: |
|
|
There are a variety of date time patterns you can express using SimpleDateFormat. The following table lists examples of different date time patterns expressed in the SimpleDateFormat and how they display. Refer to the SimpleDateFormat syntax page for more information.
|
|
|
|
>NOTE: The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone.
|
|
(This table is from the SimpleDateFormat page.)
|
|
|
|
| Date Time Pattern | Result |
|
|
| ----------------- | ------ |
|
|
| `yyyy.MM.dd G 'at' HH:mm:ss z` | `2001.07.04 AD at 12:08:56 PDT` |
|
|
| `EEE, MMM d, ''yy` | Wed, Jul 4, '01 |
|
|
| `h:mm a` | 12:08 PM |
|
|
| `hh 'o''clock' a, zzzz` | 12 o'clock PM, Pacific Daylight Time |
|
|
| `K:mm a, z` | 0:08 PM, PDT |
|
|
| `yyyyy.MMMMM.dd GGG hh:mm aaa` | 02001.July.04 AD 12:08 PM |
|
|
| `EEE, d MMM yyyy HH:mm:ss Z` | Wed, 4 Jul 2001 12:08:56 -0700 |
|
|
| `yyMMddHHmmssZ` | 010704120856-0700 |
|
|
| `yyyy-MM-dd'T'HH:mm:ss.SSSZ` | 2001-07-04T12:08:56.235-0700 |
|
|
| `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` | 2001-07-04T12:08:56.235-07:00 |
|
|
| `YYYY-'W'ww-u` | 2001-W27-3 |
|
|
example: mm/dd/yyyy
|
|
outputFormat:
|
|
description: |-
|
|
A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into.
|
|
|
|
*If no inputFormat is provided, the transform assumes that it is in ISO8601 format*
|
|
oneOf:
|
|
- $ref: '#/components/schemas/Transform/properties/attributes/oneOf/6/properties/inputFormat/oneOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/date-formats/namedConstructs.yaml
|
|
- $ref: '#/components/schemas/Transform/properties/attributes/oneOf/6/properties/inputFormat/oneOf/1'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/date-formats/simpleDateFormat.yaml
|
|
requiresPeriodicRefresh:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/RequiresPeriodicRefresh.yaml
|
|
input:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/input.yaml
|
|
- title: dateMath
|
|
type: object
|
|
required:
|
|
- expression
|
|
properties:
|
|
expression:
|
|
type: string
|
|
description: |
|
|
A string value of the date and time components to operation on, along with the math operations to execute.
|
|
externalDocs:
|
|
description: Date Math Expressions
|
|
url: https://developer.sailpoint.com/idn/docs/transforms/operations/date-math#transform-structure
|
|
example: now+1w
|
|
roundUp:
|
|
type: boolean
|
|
description: |
|
|
A boolean value to indicate whether the transform should round up or down when a rounding `/` operation is defined in the expression.
|
|
|
|
|
|
If not provided, the transform will default to `false`
|
|
|
|
|
|
`true` indicates the transform should round up (i.e., truncate the fractional date/time component indicated and then add one unit of that component)
|
|
|
|
|
|
`false` indicates the transform should round down (i.e., truncate the fractional date/time component indicated)
|
|
example: false
|
|
default: false
|
|
requiresPeriodicRefresh:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/RequiresPeriodicRefresh.yaml
|
|
input:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/input.yaml
|
|
- title: decomposeDiacriticalMarks
|
|
type: object
|
|
properties:
|
|
requiresPeriodicRefresh:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/RequiresPeriodicRefresh.yaml
|
|
input:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/input.yaml
|
|
- title: e164phone
|
|
type: object
|
|
properties:
|
|
defaultRegion:
|
|
type: string
|
|
description: |
|
|
This is an optional attribute that can be used to define the region of the phone number to format into.
|
|
|
|
|
|
If defaultRegion is not provided, it will take US as the default country.
|
|
|
|
|
|
The format of the country code should be in [ISO 3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
|
|
example: US
|
|
requiresPeriodicRefresh:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/RequiresPeriodicRefresh.yaml
|
|
input:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/input.yaml
|
|
- title: firstValid
|
|
type: object
|
|
required:
|
|
- values
|
|
properties:
|
|
values:
|
|
type: array
|
|
items:
|
|
type: object
|
|
description: An array of attributes to evaluate for existence.
|
|
example:
|
|
- attributes:
|
|
sourceName: Active Directory
|
|
attributeName: sAMAccountName
|
|
type: accountAttribute
|
|
- attributes:
|
|
sourceName: Okta
|
|
attributeName: login
|
|
type: accountAttribute
|
|
- attributes:
|
|
sourceName: HR Source
|
|
attributeName: employeeID
|
|
type: accountAttribute
|
|
ignoreErrors:
|
|
type: boolean
|
|
description: a true or false value representing to move on to the next option if an error (like an Null Pointer Exception) were to occur.
|
|
example: false
|
|
default: false
|
|
requiresPeriodicRefresh:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/RequiresPeriodicRefresh.yaml
|
|
- title: rule
|
|
oneOf:
|
|
- type: object
|
|
required:
|
|
- name
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: This is the name of the Transform rule that needs to be invoked by the transform
|
|
example: Transform Calculation Rule
|
|
requiresPeriodicRefresh:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/RequiresPeriodicRefresh.yaml
|
|
- type: object
|
|
required:
|
|
- name
|
|
- operation
|
|
- includeNumbers
|
|
- includeSpecialChars
|
|
- length
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: This must always be set to "Cloud Services Deployment Utility"
|
|
example: Cloud Services Deployment Utility
|
|
operation:
|
|
type: string
|
|
description: The operation to perform `generateRandomString`
|
|
example: generateRandomString
|
|
includeNumbers:
|
|
type: boolean
|
|
description: This must be either "true" or "false" to indicate whether the generator logic should include numbers
|
|
example: true
|
|
includeSpecialChars:
|
|
type: boolean
|
|
description: This must be either "true" or "false" to indicate whether the generator logic should include special characters
|
|
example: true
|
|
length:
|
|
type: string
|
|
description: |
|
|
This specifies how long the randomly generated string needs to be
|
|
|
|
|
|
>NOTE Due to identity attribute data constraints, the maximum allowable value is 450 characters
|
|
example: '10'
|
|
requiresPeriodicRefresh:
|
|
type: boolean
|
|
description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process
|
|
example: false
|
|
- type: object
|
|
required:
|
|
- name
|
|
- operation
|
|
- uid
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: This must always be set to "Cloud Services Deployment Utility"
|
|
example: Cloud Services Deployment Utility
|
|
operation:
|
|
type: string
|
|
description: The operation to perform `getReferenceIdentityAttribute`
|
|
example: getReferenceIdentityAttribute
|
|
uid:
|
|
type: string
|
|
description: |
|
|
This is the SailPoint User Name (uid) value of the identity whose attribute is desired
|
|
|
|
As a convenience feature, you can use the `manager` keyword to dynamically look up the user's manager and then get that manager's identity attribute.
|
|
example: 2c91808570313110017040b06f344ec9
|
|
requiresPeriodicRefresh:
|
|
type: boolean
|
|
description: A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process
|
|
example: false
|
|
- title: identityAttribute
|
|
type: object
|
|
required:
|
|
- name
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: The system (camel-cased) name of the identity attribute to bring in
|
|
example: email
|
|
requiresPeriodicRefresh:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/RequiresPeriodicRefresh.yaml
|
|
input:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/input.yaml
|
|
- title: indexOf
|
|
type: object
|
|
required:
|
|
- substring
|
|
properties:
|
|
substring:
|
|
type: string
|
|
description: A substring to search for, searches the entire calling string, and returns the index of the first occurrence of the specified substring.
|
|
example: admin_
|
|
requiresPeriodicRefresh:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/RequiresPeriodicRefresh.yaml
|
|
input:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/input.yaml
|
|
- title: iso3166
|
|
type: object
|
|
properties:
|
|
format:
|
|
type: string
|
|
description: |
|
|
An optional value to denote which ISO 3166 format to return. Valid values are:
|
|
|
|
|
|
`alpha2` - Two-character country code (e.g., "US"); this is the default value if no format is supplied
|
|
|
|
|
|
`alpha3` - Three-character country code (e.g., "USA")
|
|
|
|
|
|
`numeric` - The numeric country code (e.g., "840")
|
|
example: alpha2
|
|
requiresPeriodicRefresh:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/RequiresPeriodicRefresh.yaml
|
|
input:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/input.yaml
|
|
- title: leftPad
|
|
type: object
|
|
required:
|
|
- length
|
|
properties:
|
|
length:
|
|
type: string
|
|
description: An integer value for the desired length of the final output string
|
|
example: '4'
|
|
padding:
|
|
type: string
|
|
description: |
|
|
A string value representing the character that the incoming data should be padded with to get to the desired length
|
|
|
|
|
|
If not provided, the transform will default to a single space (" ") character for padding
|
|
example: '0'
|
|
requiresPeriodicRefresh:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/RequiresPeriodicRefresh.yaml
|
|
input:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/input.yaml
|
|
- title: lookup
|
|
type: object
|
|
required:
|
|
- table
|
|
properties:
|
|
table:
|
|
type: object
|
|
additionalProperties: true
|
|
description: |
|
|
This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched
|
|
|
|
|
|
>**Note** the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return "Unknown Region" for the attribute that is mapped to this transform.
|
|
example:
|
|
USA: Americas
|
|
FRA: EMEA
|
|
AUS: APAC
|
|
default: Unknown Region
|
|
requiresPeriodicRefresh:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/RequiresPeriodicRefresh.yaml
|
|
input:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/input.yaml
|
|
- title: lower
|
|
type: object
|
|
properties:
|
|
requiresPeriodicRefresh:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/RequiresPeriodicRefresh.yaml
|
|
input:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/input.yaml
|
|
- title: nameNormalizer
|
|
type: object
|
|
properties:
|
|
requiresPeriodicRefresh:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/RequiresPeriodicRefresh.yaml
|
|
input:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/input.yaml
|
|
- title: randomAlphaNumeric
|
|
type: object
|
|
properties:
|
|
length:
|
|
type: string
|
|
description: |
|
|
This is an integer value specifying the size/number of characters the random string must contain
|
|
|
|
|
|
* This value must be a positive number and cannot be blank
|
|
|
|
|
|
* If no length is provided, the transform will default to a value of `32`
|
|
|
|
|
|
* Due to identity attribute data constraints, the maximum allowable value is `450` characters
|
|
example: '10'
|
|
requiresPeriodicRefresh:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/RequiresPeriodicRefresh.yaml
|
|
input:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/input.yaml
|
|
- title: randomNumeric
|
|
type: object
|
|
properties:
|
|
length:
|
|
type: string
|
|
description: |
|
|
This is an integer value specifying the size/number of characters the random string must contain
|
|
|
|
|
|
* This value must be a positive number and cannot be blank
|
|
|
|
|
|
* If no length is provided, the transform will default to a value of `32`
|
|
|
|
|
|
* Due to identity attribute data constraints, the maximum allowable value is `450` characters
|
|
example: '10'
|
|
requiresPeriodicRefresh:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/RequiresPeriodicRefresh.yaml
|
|
input:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/input.yaml
|
|
- title: reference
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: This ID specifies the name of the pre-existing transform which you want to use within your current transform
|
|
example: Existing Transform
|
|
requiresPeriodicRefresh:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/RequiresPeriodicRefresh.yaml
|
|
input:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/input.yaml
|
|
- title: replaceAll
|
|
type: object
|
|
required:
|
|
- table
|
|
properties:
|
|
table:
|
|
type: object
|
|
additionalProperties: true
|
|
description: An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value.
|
|
example:
|
|
'-': ' '
|
|
'"': ''''
|
|
ñ: 'n'
|
|
requiresPeriodicRefresh:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/RequiresPeriodicRefresh.yaml
|
|
input:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/input.yaml
|
|
- title: replace
|
|
type: object
|
|
required:
|
|
- regex
|
|
- replacement
|
|
properties:
|
|
regex:
|
|
type: string
|
|
description: This can be a string or a regex pattern in which you want to replace.
|
|
example: '[^a-zA-Z]'
|
|
externalDocs:
|
|
description: Regex Builder
|
|
url: https://regex101.com/
|
|
replacement:
|
|
type: string
|
|
description: This is the replacement string that should be substituded wherever the string or pattern is found.
|
|
example: ' '
|
|
requiresPeriodicRefresh:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/RequiresPeriodicRefresh.yaml
|
|
input:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/input.yaml
|
|
- title: rightPad
|
|
type: object
|
|
required:
|
|
- length
|
|
properties:
|
|
length:
|
|
type: string
|
|
description: An integer value for the desired length of the final output string
|
|
example: '4'
|
|
padding:
|
|
type: string
|
|
description: |
|
|
A string value representing the character that the incoming data should be padded with to get to the desired length
|
|
|
|
|
|
If not provided, the transform will default to a single space (" ") character for padding
|
|
example: '0'
|
|
requiresPeriodicRefresh:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/RequiresPeriodicRefresh.yaml
|
|
input:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/input.yaml
|
|
- title: split
|
|
type: object
|
|
required:
|
|
- delimiter
|
|
- index
|
|
properties:
|
|
delimiter:
|
|
type: string
|
|
description: This can be either a single character or a regex expression, and is used by the transform to identify the break point between two substrings in the incoming data
|
|
example: ','
|
|
index:
|
|
type: string
|
|
description: An integer value for the desired array element after the incoming data has been split into a list; the array is a 0-based object, so the first array element would be index 0, the second element would be index 1, etc.
|
|
example: '5'
|
|
throws:
|
|
type: boolean
|
|
description: |
|
|
A boolean (true/false) value which indicates whether an exception should be thrown and returned as an output when an index is out of bounds with the resultant array (i.e., the provided index value is larger than the size of the array)
|
|
|
|
|
|
`true` - The transform should return "IndexOutOfBoundsException"
|
|
|
|
|
|
`false` - The transform should return null
|
|
|
|
|
|
If not provided, the transform will default to false and return a null
|
|
example: true
|
|
default: false
|
|
requiresPeriodicRefresh:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/RequiresPeriodicRefresh.yaml
|
|
input:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/input.yaml
|
|
- title: static
|
|
type: object
|
|
required:
|
|
- values
|
|
properties:
|
|
values:
|
|
type: string
|
|
description: This must evaluate to a JSON string, either through a fixed value or through conditional logic using the Apache Velocity Template Language.
|
|
example: string$variable
|
|
externalDocs:
|
|
description: Static Transform Documentation
|
|
url: https://developer.sailpoint.com/idn/docs/transforms/operations/static
|
|
requiresPeriodicRefresh:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/RequiresPeriodicRefresh.yaml
|
|
- title: substring
|
|
type: object
|
|
required:
|
|
- begin
|
|
properties:
|
|
begin:
|
|
type: integer
|
|
description: |
|
|
The index of the first character to include in the returned substring.
|
|
|
|
|
|
If `begin` is set to -1, the transform will begin at character 0 of the input data
|
|
example: 1
|
|
format: int32
|
|
beginOffset:
|
|
type: integer
|
|
description: |
|
|
This integer value is the number of characters to add to the begin attribute when returning a substring.
|
|
|
|
This attribute is only used if begin is not -1.
|
|
example: 3
|
|
format: int32
|
|
end:
|
|
type: integer
|
|
description: |
|
|
The index of the first character to exclude from the returned substring.
|
|
|
|
If end is -1 or not provided at all, the substring transform will return everything up to the end of the input string.
|
|
example: 6
|
|
format: int32
|
|
endOffset:
|
|
type: integer
|
|
description: |
|
|
This integer value is the number of characters to add to the end attribute when returning a substring.
|
|
|
|
This attribute is only used if end is provided and is not -1.
|
|
example: 1
|
|
format: int32
|
|
requiresPeriodicRefresh:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/RequiresPeriodicRefresh.yaml
|
|
input:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/input.yaml
|
|
- title: trim
|
|
type: object
|
|
properties:
|
|
requiresPeriodicRefresh:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/RequiresPeriodicRefresh.yaml
|
|
input:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/input.yaml
|
|
- title: upper
|
|
type: object
|
|
properties:
|
|
requiresPeriodicRefresh:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/RequiresPeriodicRefresh.yaml
|
|
input:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/input.yaml
|
|
- title: uuid
|
|
type: object
|
|
properties:
|
|
requiresPeriodicRefresh:
|
|
$ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/transforms/RequiresPeriodicRefresh.yaml
|
|
WorkItems:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: ID of the work item
|
|
example: 2c9180835d2e5168015d32f890ca1581
|
|
requesterId:
|
|
type: string
|
|
description: ID of the requester
|
|
example: 2c9180835d2e5168015d32f890ca1581
|
|
nullable: true
|
|
requesterDisplayName:
|
|
type: string
|
|
description: The displayname of the requester
|
|
example: John Smith
|
|
nullable: true
|
|
ownerId:
|
|
type: string
|
|
description: The ID of the owner
|
|
example: 2c9180835d2e5168015d32f890ca1581
|
|
nullable: true
|
|
ownerName:
|
|
type: string
|
|
description: The name of the owner
|
|
example: Jason Smith
|
|
created:
|
|
type: string
|
|
format: date-time
|
|
example: '2017-07-11T18:45:37.098Z'
|
|
description: Time when the work item was created
|
|
modified:
|
|
type: string
|
|
format: date-time
|
|
example: '2018-06-25T20:22:28.104Z'
|
|
description: Time when the work item was last updated
|
|
nullable: true
|
|
description:
|
|
type: string
|
|
description: The description of the work item
|
|
example: Create account on source 'AD'
|
|
state:
|
|
type: string
|
|
enum:
|
|
- Finished
|
|
- Rejected
|
|
- Returned
|
|
- Expired
|
|
- Pending
|
|
- Canceled
|
|
example: Finished
|
|
description: The state of a work item
|
|
type:
|
|
type: string
|
|
enum:
|
|
- Generic
|
|
- Certification
|
|
- Remediation
|
|
- Delegation
|
|
- Approval
|
|
- ViolationReview
|
|
- Form
|
|
- PolicyVioloation
|
|
- Challenge
|
|
- ImpactAnalysis
|
|
- Signoff
|
|
- Event
|
|
- ManualAction
|
|
- Test
|
|
example: Generic
|
|
description: The type of the work item
|
|
remediationItems:
|
|
type: array
|
|
nullable: true
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The ID of the certification
|
|
example: 2c9180835d2e5168015d32f890ca1581
|
|
targetId:
|
|
type: string
|
|
description: The ID of the certification target
|
|
example: 2c9180835d2e5168015d32f890ca1581
|
|
targetName:
|
|
type: string
|
|
description: The name of the certification target
|
|
example: john.smith
|
|
targetDisplayName:
|
|
type: string
|
|
description: The display name of the certification target
|
|
example: emailAddress
|
|
applicationName:
|
|
type: string
|
|
description: The name of the application/source
|
|
example: Active Directory
|
|
attributeName:
|
|
type: string
|
|
description: The name of the attribute being certified
|
|
example: phoneNumber
|
|
attributeOperation:
|
|
type: string
|
|
description: The operation of the certification on the attribute
|
|
example: update
|
|
attributeValue:
|
|
type: string
|
|
description: The value of the attribute being certified
|
|
example: 512-555-1212
|
|
nativeIdentity:
|
|
type: string
|
|
description: The native identity of the target
|
|
example: jason.smith2
|
|
description: A list of remediation items
|
|
approvalItems:
|
|
type: array
|
|
nullable: true
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The approval item's ID
|
|
example: 2c9180835d2e5168015d32f890ca1581
|
|
account:
|
|
type: string
|
|
description: The account referenced by the approval item
|
|
example: john.smith
|
|
nullable: true
|
|
application:
|
|
type: string
|
|
description: The name of the application/source
|
|
example: Active Directory
|
|
name:
|
|
type: string
|
|
description: The attribute's name
|
|
example: emailAddress
|
|
nullable: true
|
|
operation:
|
|
type: string
|
|
description: The attribute's operation
|
|
example: update
|
|
value:
|
|
type: string
|
|
description: The attribute's value
|
|
example: a@b.com
|
|
nullable: true
|
|
state:
|
|
allOf:
|
|
- $ref: '#/components/schemas/ApprovalItems/properties/state/allOf/0'
|
|
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/WorkItemState.yaml
|
|
- nullable: true
|
|
description: A list of items that need to be approved
|
|
name:
|
|
type: string
|
|
description: The work item name
|
|
example: Account Create
|
|
nullable: true
|
|
completed:
|
|
type: string
|
|
format: date-time
|
|
example: '2018-10-19T13:49:37.385Z'
|
|
description: The time at which the work item completed
|
|
nullable: true
|
|
numItems:
|
|
type: integer
|
|
format: int32
|
|
description: The number of items in the work item
|
|
example: 19
|
|
nullable: true
|
|
form:
|
|
allOf:
|
|
- type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: ID of the form
|
|
example: 2c9180835d2e5168015d32f890ca1581
|
|
nullable: true
|
|
name:
|
|
type: string
|
|
description: Name of the form
|
|
example: AccountSelection Form
|
|
nullable: true
|
|
title:
|
|
type: string
|
|
description: The form title
|
|
example: Account Selection for John.Doe
|
|
subtitle:
|
|
type: string
|
|
description: The form subtitle.
|
|
example: Please select from the following
|
|
targetUser:
|
|
type: string
|
|
description: The name of the user that should be shown this form
|
|
example: Jane.Doe
|
|
sections:
|
|
type: array
|
|
items:
|
|
type: object
|
|
allOf:
|
|
- type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Name of the FormItem
|
|
example: Field1
|
|
- type: object
|
|
properties:
|
|
label:
|
|
type: string
|
|
description: Label of the section
|
|
example: Section 1
|
|
formItems:
|
|
type: array
|
|
items:
|
|
type: object
|
|
description: List of FormItems. FormItems can be SectionDetails and/or FieldDetails
|
|
example: []
|
|
description: Sections of the form
|
|
- nullable: true
|
|
errors:
|
|
type: array
|
|
items:
|
|
type: string
|
|
example:
|
|
- The work item ID that was specified was not found.
|
|
description: An array of errors that ocurred during the work item
|
|
WorkItemsCount:
|
|
type: object
|
|
properties:
|
|
count:
|
|
type: integer
|
|
description: The count of work items
|
|
example: 29
|
|
WorkItemsSummary:
|
|
type: object
|
|
properties:
|
|
open:
|
|
type: integer
|
|
description: The count of open work items
|
|
example: 29
|
|
completed:
|
|
type: integer
|
|
description: The count of completed work items
|
|
example: 1
|
|
total:
|
|
type: integer
|
|
description: The count of total work items
|
|
example: 30
|
|
AccountUsage:
|
|
type: object
|
|
properties:
|
|
date:
|
|
type: string
|
|
format: date
|
|
description: The first day of the month for which activity is aggregated.
|
|
example: '2023-04-21'
|
|
count:
|
|
type: integer
|
|
format: int64
|
|
description: The number of days within the month that the account was active in a source.
|
|
example: 10
|
|
SourceUsage:
|
|
type: object
|
|
properties:
|
|
date:
|
|
type: string
|
|
format: date
|
|
description: The first day of the month for which activity is aggregated.
|
|
example: '2023-04-21'
|
|
count:
|
|
type: number
|
|
format: float
|
|
description: The average number of days that accounts were active within this source, for the month.
|
|
example: 10.45
|
|
SourceUsageStatus:
|
|
type: object
|
|
properties:
|
|
status:
|
|
type: string
|
|
description: |-
|
|
Source Usage Status. Acceptable values are:
|
|
- COMPLETE
|
|
- This status means that an activity data source has been setup and usage insights are available for the source.
|
|
- INCOMPLETE
|
|
- This status means that an activity data source has not been setup and usage insights are not available for the source.
|
|
example: COMPLETE
|
|
enum:
|
|
- COMPLETE
|
|
- INCOMPLETE
|
|
BrandingItem:
|
|
type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: name of branding item
|
|
example: default
|
|
productName:
|
|
type: string
|
|
description: product name
|
|
example: product name
|
|
nullable: true
|
|
actionButtonColor:
|
|
type: string
|
|
description: hex value of color for action button
|
|
example: 0074D9
|
|
nullable: true
|
|
activeLinkColor:
|
|
type: string
|
|
description: hex value of color for link
|
|
example: 1.1e+70
|
|
nullable: true
|
|
navigationColor:
|
|
type: string
|
|
description: hex value of color for navigation bar
|
|
example: 1.1e+70
|
|
nullable: true
|
|
emailFromAddress:
|
|
type: string
|
|
description: email from address
|
|
example: no-reply@sailpoint.com
|
|
nullable: true
|
|
standardLogoURL:
|
|
type: string
|
|
description: url to standard logo
|
|
example: ''
|
|
nullable: true
|
|
loginInformationalMessage:
|
|
type: string
|
|
description: login information message
|
|
example: ''
|
|
nullable: true
|
|
BrandingItemCreate:
|
|
type: object
|
|
required:
|
|
- name
|
|
- productName
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: name of branding item
|
|
example: custom-branding-item
|
|
productName:
|
|
type: string
|
|
description: product name
|
|
example: product name
|
|
nullable: true
|
|
actionButtonColor:
|
|
type: string
|
|
description: hex value of color for action button
|
|
example: 0074D9
|
|
activeLinkColor:
|
|
type: string
|
|
description: hex value of color for link
|
|
example: 1.1e+70
|
|
navigationColor:
|
|
type: string
|
|
description: hex value of color for navigation bar
|
|
example: 1.1e+70
|
|
emailFromAddress:
|
|
type: string
|
|
description: email from address
|
|
example: no-reply@sailpoint.com
|
|
loginInformationalMessage:
|
|
type: string
|
|
description: login information message
|
|
example: ''
|
|
fileStandard:
|
|
type: string
|
|
format: binary
|
|
description: png file with logo
|
|
example: \x00\x00\x00\x02
|