diff --git a/dereferenced/idn-v3-spec.yaml b/dereferenced/idn-v3-spec.yaml
new file mode 100644
index 0000000..5adf7a3
--- /dev/null
+++ b/dereferenced/idn-v3-spec.yaml
@@ -0,0 +1,93472 @@
+openapi: 3.0.1
+info:
+ title: IdentityNow V3 API
+ description: 'Use these APIs to interact with the IdentityNow 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.'
+tags:
+ - 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 IdentityNow, 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, IdentityNow 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 IdentityNow, 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, IdentityNow grants or revokes access, based on the request.
+ If multiple reviewers are required, IdentityNow 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 the following link for more information about access request approvals:
+ externalDocs:
+ description: Learn more about access request approvals
+ url: 'https://documentation.sailpoint.com/saas/help/requests/index.html'
+ - 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.
+
+ IdentityNow'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 IdentityNow, 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 IdentityNow 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 the following link for more information about access requests:
+ externalDocs:
+ description: Learn more about access requests
+ url: 'https://documentation.sailpoint.com/saas/user-help/requests/requesting_access.html'
+ - 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 IdentityNow.
+
+ In IdentityNow, 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. IdentityNow loads accounts through the creation of sources in IdentityNow.
+
+ Administrators can correlate users' identities with the users' accounts on the different sources they use.
+ This allows IdentityNow 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 IdentityNow, 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 IdentityNow. 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 the following link for more information about accounts:
+ externalDocs:
+ description: Learn more about accounts
+ url: 'https://documentation.sailpoint.com/saas/help/common/users/user_access.html'
+ - 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 IdentityNow, 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 IdentityNow'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 IdentityNow completes on source accounts. Users can search in IdentityNow 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.
+ IdentityNow 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 IdentityNow 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 the following link for more information about account activities:
+ externalDocs:
+ description: Learn more about account activities
+ url: 'https://documentation.sailpoint.com/saas/help/search/index.html'
+ - name: Certifications
+ - name: Certification Summaries
+ - 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 IdentityNow: '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. See [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 IdentityNow manages users' access to apps and sources for each lifecycle state.
+
+ In IdentityNow, 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, IdentityNow evaluates lifFecycle states to determine whether their assigned identities have the access defined in the lifecycle states' access profiles.
+ If the identities are missing access, IdentityNow provisions that access.
+
+ Administrators can also use the 'Provisioning' tab to configure email notifications for IdentityNow to send whenever an identity with that identity profile has a lifecycle state change.
+ See [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.'
+ See [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 the following link for more information about lifecycle states:
+ externalDocs:
+ description: Learn more about lifecycle states
+ url: 'https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html'
+ - 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 IdentityNow, 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 the following link for more information about identity profiles:
+ externalDocs:
+ description: Learn more about identity profiles
+ url: 'https://documentation.sailpoint.com/saas/help/setup/identity_profiles.html'
+ - 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 IdentityNow 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 IdentityNow.
+
+ - 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 IdentityNow, administrators must create a non-employee source and add accounts to the source.
+
+ To create a non-employee source in IdentityNow, administrators must use the Admin panel to go to Connections > Sources.
+ They must then specify 'Non-Employee' in the 'Source Type' field.
+ See [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 IdentityNow, 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.
+ See [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 the following link for more information about non-employee lifecycle management:
+ externalDocs:
+ description: Learn more about non-employee lifecycle management
+ url: 'https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html'
+ - name: OAuth Clients
+ - 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 IdentityNow, 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 the following link for more information about password management:
+ externalDocs:
+ description: Learn more about password management
+ url: 'https://documentation.sailpoint.com/saas/user-help/accounts/passwords.html'
+ - 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 IdentityNow.
+
+ 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 IdentityNow organizations' integration security.
+
+ In IdentityNow, 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 the following link for more information about PATs:
+ externalDocs:
+ description: Learn more about PATs
+ url: 'https://documentation.sailpoint.com/saas/help/common/generate_tokens.html'
+ - name: Public Identities
+ description: |
+ Use this API in conjunction with [Public Identites Config](https://developer.sailpoint.com/apis/v3/#tag/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/apis/v3/#operation/updatePublicIdentityConfig) to make the "department" attribute public, the approver can see the department and make a decision without requesting any more information.
+ - 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/apis/v3/#tag/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: Saved Search
+ - name: Scheduled Search
+ - name: Search
+ - name: Service Desk Integration
+ description: Operations for creating and accessing service desk integrations
+ - name: Sources
+ - 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.
+ externalDocs:
+ description: Learn more about Building Transforms
+ url: 'https://developer.sailpoint.com/docs/transforms/building_transforms/building_transforms.html'
+ - 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 IdentityNow'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 the following link for more information about work items, like the different types of work items users may need to complete:
+ externalDocs:
+ description: Learn more about work items
+ url: 'https://documentation.sailpoint.com/saas/user-help/task_manager.html'
+paths:
+ /access-requests:
+ post:
+ operationId: createAccessRequest
+ summary: Submit an Access Request
+ tags:
+ - Access Requests
+ description: |
+ This submits the access request into IdentityNow, where it will follow any IdentityNow approval processes.
+
+ Access requests are processed asynchronously by IdentityNow. A success response from this endpoint means the request
+ has been submitted to IDN and is queued for processing. Because this endpoint is asynchronous, it will not return an error
+ if you submit duplicate access requests in quick succession, or you submit an access request for access that is already in progress, approved, or rejected.
+ It is 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 [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) endpoints. You can also
+ use the [search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items that an identity has before submitting
+ an access request to ensure you are not requesting access that is already granted.
+
+ 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, see '/beta/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.
+ * Does not support self request. Only manager can request to revoke access for their directly managed employees.
+ * If removeDate is specified, then the access will be removed on that date and time.
+ * Allows a manager to request to revoke access for direct employees. A token with ORG_ADMIN authority can also request to revoke access from anyone.
+ * Roles and Access Profiles can be requested for revocation. Revoke request for entitlements are not supported currently.
+
+ NOTE: There is no indication to the approver in the IdentityNow UI that the approval request is for a revoke action. Take this into consideration when calling this API.
+
+ A token with API authority cannot be used to call this endpoint.
+ 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:
+ type: string
+ enum:
+ - GRANT_ACCESS
+ - REVOKE_ACCESS
+ description: Access request type. Defaults to GRANT_ACCESS. REVOKE_ACCESS type can only have a single Identity ID in the requestedFor field. Currently REVOKE_ACCESS is not supported for entitlements.
+ example: GRANT_ACCESS
+ 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.
+ removeDate:
+ type: string
+ description: |
+ The date the role or access profile is no longer assigned to the specified identity.
+ * 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.
+ * Currently it is not supported for entitlements.
+ format: date-time
+ example: '2020-07-11T21:23:15.000Z'
+ required:
+ - id
+ - type
+ 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: Accepted - Returned if the request was successfully accepted into the system.
+ content:
+ application/json:
+ schema:
+ type: object
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ /access-requests/cancel:
+ post:
+ operationId: cancelAccessRequest
+ 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.
+ Any token with ORG_ADMIN authority or token of the user who originally requested the access request is required to 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: ID of the account activity object corresponding to the access request.
+ 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':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '404':
+ description: Not Found - returned if the request URL refers to a resource or object that does not exist
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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':
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ /access-request-config:
+ get:
+ operationId: getAccessRequestConfig
+ 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 true, then approvals must be processed by external system.'
+ example: true
+ autoApprovalEnabled:
+ type: boolean
+ description: 'If true and requester and reviewer are the same, then automatically approve the approval.'
+ example: true
+ requestOnBehalfOfConfig:
+ description: Request On Behalf Of Configuration.
+ type: object
+ properties:
+ allowRequestOnBehalfOfAnyoneByAnyone:
+ type: boolean
+ description: If anyone can request access for anyone.
+ example: true
+ allowRequestOnBehalfOfEmployeeByManager:
+ type: boolean
+ description: If a manager can request access for his/her direct reports.
+ example: true
+ approvalReminderAndEscalationConfig:
+ description: Approval Reminder and Escalation Configuration.
+ 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
+ daysBetweenReminders:
+ type: integer
+ description: Number of days to wait between reminder notifications.
+ format: int32
+ example: 0
+ maxReminders:
+ type: integer
+ description: Maximum number of reminder notification to send to the reviewer before approval escalation.
+ format: int32
+ example: 0
+ fallbackApproverRef:
+ 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: Human-readable display name of identity. This is read-only
+ example: Alison Ferguso
+ email:
+ type: string
+ description: Email address of identity. This is read-only
+ example: alison.ferguso@identitysoon.com
+ entitlementRequestConfig:
+ description: Entitlement Request Configuration.
+ type: object
+ properties:
+ allowEntitlementRequest:
+ type: boolean
+ description: Flag for allowing entitlement request.
+ example: true
+ requestCommentsRequired:
+ type: boolean
+ description: Flag for requiring comments while submitting an entitlement request.
+ default: false
+ example: false
+ deniedCommentsRequired:
+ type: boolean
+ description: Flag for requiring comments while rejecting an entitlement request.
+ 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 "sourceOwner", "manager" and "workgroup:{id}".
+ Multiple workgroups (governance groups) can be used.
+ default: sourceOwner
+ example: 'sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584'
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ put:
+ operationId: updateAccessRequestConfig
+ summary: Update Access Request Configuration
+ tags:
+ - Access Requests
+ description: |-
+ This endpoint replaces the current access-request configuration.
+ A token with ORG_ADMIN authority is required to call this API.
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ approvalsMustBeExternal:
+ type: boolean
+ description: 'If true, then approvals must be processed by external system.'
+ example: true
+ autoApprovalEnabled:
+ type: boolean
+ description: 'If true and requester and reviewer are the same, then automatically approve the approval.'
+ example: true
+ requestOnBehalfOfConfig:
+ description: Request On Behalf Of Configuration.
+ type: object
+ properties:
+ allowRequestOnBehalfOfAnyoneByAnyone:
+ type: boolean
+ description: If anyone can request access for anyone.
+ example: true
+ allowRequestOnBehalfOfEmployeeByManager:
+ type: boolean
+ description: If a manager can request access for his/her direct reports.
+ example: true
+ approvalReminderAndEscalationConfig:
+ description: Approval Reminder and Escalation Configuration.
+ 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
+ daysBetweenReminders:
+ type: integer
+ description: Number of days to wait between reminder notifications.
+ format: int32
+ example: 0
+ maxReminders:
+ type: integer
+ description: Maximum number of reminder notification to send to the reviewer before approval escalation.
+ format: int32
+ example: 0
+ fallbackApproverRef:
+ 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: Human-readable display name of identity. This is read-only
+ example: Alison Ferguso
+ email:
+ type: string
+ description: Email address of identity. This is read-only
+ example: alison.ferguso@identitysoon.com
+ entitlementRequestConfig:
+ description: Entitlement Request Configuration.
+ type: object
+ properties:
+ allowEntitlementRequest:
+ type: boolean
+ description: Flag for allowing entitlement request.
+ example: true
+ requestCommentsRequired:
+ type: boolean
+ description: Flag for requiring comments while submitting an entitlement request.
+ default: false
+ example: false
+ deniedCommentsRequired:
+ type: boolean
+ description: Flag for requiring comments while rejecting an entitlement request.
+ 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 "sourceOwner", "manager" and "workgroup:{id}".
+ Multiple workgroups (governance groups) can be used.
+ default: sourceOwner
+ example: 'sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584'
+ responses:
+ '200':
+ description: Access Request Configuration Details.
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ approvalsMustBeExternal:
+ type: boolean
+ description: 'If true, then approvals must be processed by external system.'
+ example: true
+ autoApprovalEnabled:
+ type: boolean
+ description: 'If true and requester and reviewer are the same, then automatically approve the approval.'
+ example: true
+ requestOnBehalfOfConfig:
+ description: Request On Behalf Of Configuration.
+ type: object
+ properties:
+ allowRequestOnBehalfOfAnyoneByAnyone:
+ type: boolean
+ description: If anyone can request access for anyone.
+ example: true
+ allowRequestOnBehalfOfEmployeeByManager:
+ type: boolean
+ description: If a manager can request access for his/her direct reports.
+ example: true
+ approvalReminderAndEscalationConfig:
+ description: Approval Reminder and Escalation Configuration.
+ 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
+ daysBetweenReminders:
+ type: integer
+ description: Number of days to wait between reminder notifications.
+ format: int32
+ example: 0
+ maxReminders:
+ type: integer
+ description: Maximum number of reminder notification to send to the reviewer before approval escalation.
+ format: int32
+ example: 0
+ fallbackApproverRef:
+ 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: Human-readable display name of identity. This is read-only
+ example: Alison Ferguso
+ email:
+ type: string
+ description: Email address of identity. This is read-only
+ example: alison.ferguso@identitysoon.com
+ entitlementRequestConfig:
+ description: Entitlement Request Configuration.
+ type: object
+ properties:
+ allowEntitlementRequest:
+ type: boolean
+ description: Flag for allowing entitlement request.
+ example: true
+ requestCommentsRequired:
+ type: boolean
+ description: Flag for requiring comments while submitting an entitlement request.
+ default: false
+ example: false
+ deniedCommentsRequired:
+ type: boolean
+ description: Flag for requiring comments while rejecting an entitlement request.
+ 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 "sourceOwner", "manager" and "workgroup:{id}".
+ Multiple workgroups (governance groups) can be used.
+ default: sourceOwner
+ example: 'sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584'
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ /access-request-status:
+ get:
+ operationId: listAccessRequestStatus
+ tags:
+ - Access Requests
+ summary: Access Request Status
+ description: |-
+ The Access Request Status API returns a list of access request statuses based on the specified query parameters.
+ Any token with any authority can request their own status. A token with ORG_ADMIN authority 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 for which the requests were made. *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 that 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 which 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: 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.
+ 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:
+
+ **accountActivityItemId**: *eq, in*
+ - 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**
+ example: created
+ responses:
+ '200':
+ description: List of requested item status.
+ 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
+ type:
+ type: string
+ enum:
+ - ACCESS_PROFILE
+ - ROLE
+ - ENTITLEMENT
+ description: Type of requested object.
+ example: ACCESS_PROFILE
+ cancelledRequestDetails:
+ type: object
+ properties:
+ comment:
+ type: string
+ description: Comment made by the owner when cancelling the associated request.
+ example: Nisl quis ipsum quam quisque condimentum nunc ut dolor nunc.
+ owner:
+ type: object
+ properties:
+ type:
+ description: DTO 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ example: IDENTITY
+ 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
+ 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.
+ errorMessages:
+ type: array
+ items:
+ type: array
+ items:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ forwarded:
+ type: boolean
+ description: True if the request for this item was forwarded from one owner to another.
+ originalOwner:
+ description: 'Base identity/workgroup reference object representing the original owner, if forwarded.'
+ type: object
+ properties:
+ type:
+ description: DTO 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ example: IDENTITY
+ 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
+ currentOwner:
+ description: Base reference of approver that will make decision.
+ type: object
+ properties:
+ type:
+ description: DTO 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ example: IDENTITY
+ 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
+ reviewedBy:
+ description: The identity who has reviewed the approval.
+ type: object
+ properties:
+ type:
+ description: DTO 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ example: IDENTITY
+ 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
+ modified:
+ type: string
+ format: date-time
+ description: Time at which item was modified.
+ example: '2019-08-23T18:52:57.398Z'
+ 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
+ - GOVERNANCE_GROUP
+ description: Describes the individual or group that is responsible for an approval step.
+ errorMessages:
+ type: array
+ items:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ description: 'If the request failed, includes any error messages that were generated.'
+ comment:
+ type: string
+ description: 'Comment, if any, provided by the approver.'
+ removeDate:
+ type: string
+ description: The date the role or access profile is no longer assigned to the specified identity.
+ format: date-time
+ example: '2020-07-11T00:00:00Z'
+ description: Approval details for each item.
+ manualWorkItemDetails:
+ type: array
+ items:
+ type: object
+ properties:
+ forwarded:
+ type: boolean
+ description: True if the request for this item was forwarded from one owner to another.
+ example: true
+ originalOwner:
+ description: 'Base identity/workgroup reference object representing the original owner, if forwarded.'
+ type: object
+ properties:
+ type:
+ description: DTO 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ example: IDENTITY
+ 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
+ currentOwner:
+ description: Base reference of approver that will make decision.
+ type: object
+ properties:
+ type:
+ description: DTO 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ example: IDENTITY
+ 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
+ modified:
+ type: string
+ format: date-time
+ description: Time at which item was modified.
+ example: '2019-08-23T18:52:57.398Z'
+ 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
+ description: Manual work items created for provisioning the item.
+ accountActivityItemId:
+ type: string
+ description: Id of associated account activity item.
+ example: 2c9180926cbfbddd016cbfc7c3b10010
+ requestType:
+ type: string
+ enum:
+ - GRANT_ACCESS
+ - REVOKE_ACCESS
+ description: Access request type. Defaults to GRANT_ACCESS. REVOKE_ACCESS type can only have a single Identity ID in the requestedFor field. Currently REVOKE_ACCESS is not supported for entitlements.
+ example: GRANT_ACCESS
+ 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'
+ requester:
+ description: The identity that requested the item.
+ type: object
+ properties:
+ type:
+ description: DTO 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ example: IDENTITY
+ 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
+ requestedFor:
+ description: The identity for whom the Access Request Status is requested for.
+ type: object
+ properties:
+ type:
+ description: DTO 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ example: IDENTITY
+ 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
+ requesterComment:
+ description: The requester's comment.
+ type: object
+ properties:
+ comment:
+ type: string
+ description: Content of the comment
+ example: Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat
+ author:
+ 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure.
+ example: IDENTITY
+ id:
+ type: string
+ description: ID of the author
+ example: 2c91808568c529c60168cca6f90c1313
+ name:
+ type: string
+ description: Human-readable display name of the identity making the comment
+ example: Adam Kennedy
+ created:
+ type: string
+ format: date-time
+ description: Date and time comment was created
+ example: '2017-07-11T18:45:37.098Z'
+ sodViolationContext:
+ description: The details of the SOD violations for the associated approval.
+ type: object
+ properties:
+ state:
+ type: string
+ enum:
+ - SUCCESS
+ - ERROR
+ description: The status of SOD violation check
+ example: SUCCESS
+ uuid:
+ description: The id of the Violation check event
+ type: string
+ example: f73d16e9-a038-46c5-b217-1246e15fdbdd
+ violationCheckResult:
+ description: The inner object representing the completed SOD Violation check
+ type: object
+ properties:
+ message:
+ description: 'If the request failed, includes any error message that was generated.'
+ example:
+ - locale: en-US
+ localeOrigin: DEFAULT
+ text: An error has occurred during the SOD violation check
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ requestedAppName: test-app
+ requestedAppId: 2c91808f7892918f0178b78da4a305a1
+ violationContexts:
+ type: array
+ items:
+ description: The contextual information of the violated criteria
+ type: object
+ properties:
+ policy:
+ description: Reference to the Policy that is being violated.
+ type: object
+ properties:
+ type:
+ description: DTO 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ example: IDENTITY
+ 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
+ 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
+ example: true
+ description: If the entitlement already belonged to the user or not.
+ type:
+ example: ENTITLEMENT
+ 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure.
+ 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:
+ description: Details of the Entitlement criteria
+ type: object
+ properties:
+ existing:
+ type: boolean
+ example: true
+ description: If the entitlement already belonged to the user or not.
+ type:
+ example: ENTITLEMENT
+ 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure.
+ id:
+ type: string
+ description: Entitlement ID
+ example: 2c918085771e9d3301773b3cb66f6398
+ name:
+ type: string
+ description: Entitlement name
+ example: My HR Entitlement
+ violatedPolicies:
+ type: array
+ description: A list of the Policies that were violated
+ items:
+ description: Reference to the policy that was violated
+ example:
+ - type: SOD_POLICY
+ id: 69129440-422d-4a23-aadd-35c828d5bfda
+ name: HR Policy
+ type: object
+ properties:
+ type:
+ description: DTO 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ example: IDENTITY
+ 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
+ provisioningDetails:
+ 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.
+ preApprovalTriggerDetails:
+ 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.
+ 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'
+ name:
+ type: string
+ description: The name of this phase.
+ example: APPROVAL_PHASE
+ state:
+ type: string
+ enum:
+ - PENDING
+ - EXECUTING
+ - COMPLETED
+ - CANCELLED
+ description: The state of this phase.
+ example: COMPLETED
+ result:
+ type: string
+ enum:
+ - SUCCESSFUL
+ - FAILED
+ description: The state of this phase.
+ example: SUCCESSFUL
+ 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
+ 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.'
+ description:
+ type: string
+ description: Description associated to the requested object.
+ example: This is the Engineering role that engineers are granted.
+ removeDate:
+ type: string
+ format: date-time
+ description: When the role access is scheduled for removal.
+ example: '2019-10-23T00:00:00.000Z'
+ cancelable:
+ type: boolean
+ description: True if the request can be canceled.
+ example: true
+ accessRequestId:
+ type: string
+ format: uuid
+ description: This is the account activity id.
+ example: ef38f94347e94562b5bb8424a56397d8
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ /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
+ - 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
+ - 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
+ 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*
+ 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:
+ description: If the access-request was for granting or revoking access.
+ type: string
+ enum:
+ - GRANT_ACCESS
+ - REVOKE_ACCESS
+ example: GRANT_ACCESS
+ requester:
+ description: The identity that requested the item.
+ type: object
+ properties:
+ type:
+ description: DTO 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ example: IDENTITY
+ 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
+ requestedFor:
+ description: The identity for whom the item is requested for.
+ type: object
+ properties:
+ type:
+ description: DTO 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ example: IDENTITY
+ 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
+ owner:
+ description: The owner or approver of the approval.
+ type: object
+ properties:
+ type:
+ description: DTO 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ example: IDENTITY
+ 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
+ requestedObject:
+ description: The requested access item.
+ 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:
+ description: The requester's comment.
+ type: object
+ properties:
+ comment:
+ type: string
+ description: Content of the comment
+ example: Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat
+ author:
+ 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure.
+ example: IDENTITY
+ id:
+ type: string
+ description: ID of the author
+ example: 2c91808568c529c60168cca6f90c1313
+ name:
+ type: string
+ description: Human-readable display name of the identity making the comment
+ example: Adam Kennedy
+ created:
+ type: string
+ format: date-time
+ description: Date and time comment was created
+ example: '2017-07-11T18:45:37.098Z'
+ previousReviewersComments:
+ type: array
+ items:
+ type: object
+ properties:
+ comment:
+ type: string
+ description: Content of the comment
+ example: Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat
+ author:
+ 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure.
+ example: IDENTITY
+ id:
+ type: string
+ description: ID of the author
+ example: 2c91808568c529c60168cca6f90c1313
+ name:
+ type: string
+ description: Human-readable display name of the identity making the comment
+ example: Adam Kennedy
+ created:
+ type: string
+ format: date-time
+ description: Date and time comment was created
+ example: '2017-07-11T18:45:37.098Z'
+ description: The history of the previous reviewers comments.
+ forwardHistory:
+ type: array
+ items:
+ type: object
+ properties:
+ oldApproverName:
+ type: string
+ description: Display name of approver that forwarded the approval.
+ example: frank.mir
+ newApproverName:
+ type: string
+ description: Display name of approver to whom the approval was forwarded.
+ example: al.volta
+ comment:
+ type: string
+ description: Comment made by old approver when forwarding.
+ example: Fusce id orci vel consectetur amet ipsum quam.
+ modified:
+ type: string
+ format: date-time
+ description: Time at which approval was forwarded.
+ example: '2019-08-23T18:52:57.398Z'
+ description: The history of approval forward action.
+ commentRequiredWhenRejected:
+ type: boolean
+ description: When true the rejector has to provide comments when rejecting
+ example: true
+ actionInProcess:
+ description: 'Action that is performed on this approval, and system has not finished performing that action yet.'
+ type: string
+ enum:
+ - APPROVED
+ - REJECTED
+ - FORWARDED
+ example: APPROVED
+ removeDate:
+ type: string
+ description: The date the role or access profile is no longer assigned to the specified identity.
+ format: date-time
+ example: '2020-07-11T00:00:00Z'
+ removeDateUpdateRequested:
+ type: boolean
+ 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:
+ description: The details of the SOD violations for the associated approval.
+ type: object
+ properties:
+ state:
+ type: string
+ enum:
+ - SUCCESS
+ - ERROR
+ description: The status of SOD violation check
+ example: SUCCESS
+ uuid:
+ description: The id of the Violation check event
+ type: string
+ example: f73d16e9-a038-46c5-b217-1246e15fdbdd
+ violationCheckResult:
+ description: The inner object representing the completed SOD Violation check
+ type: object
+ properties:
+ message:
+ description: 'If the request failed, includes any error message that was generated.'
+ example:
+ - locale: en-US
+ localeOrigin: DEFAULT
+ text: An error has occurred during the SOD violation check
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ requestedAppName: test-app
+ requestedAppId: 2c91808f7892918f0178b78da4a305a1
+ violationContexts:
+ type: array
+ items:
+ description: The contextual information of the violated criteria
+ type: object
+ properties:
+ policy:
+ description: Reference to the Policy that is being violated.
+ type: object
+ properties:
+ type:
+ description: DTO 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ example: IDENTITY
+ 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
+ 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
+ example: true
+ description: If the entitlement already belonged to the user or not.
+ type:
+ example: ENTITLEMENT
+ 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure.
+ 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:
+ description: Details of the Entitlement criteria
+ type: object
+ properties:
+ existing:
+ type: boolean
+ example: true
+ description: If the entitlement already belonged to the user or not.
+ type:
+ example: ENTITLEMENT
+ 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure.
+ id:
+ type: string
+ description: Entitlement ID
+ example: 2c918085771e9d3301773b3cb66f6398
+ name:
+ type: string
+ description: Entitlement name
+ example: My HR Entitlement
+ violatedPolicies:
+ type: array
+ description: A list of the Policies that were violated
+ items:
+ description: Reference to the policy that was violated
+ example:
+ - type: SOD_POLICY
+ id: 69129440-422d-4a23-aadd-35c828d5bfda
+ name: HR Policy
+ type: object
+ properties:
+ type:
+ description: DTO 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ example: IDENTITY
+ 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
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ /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
+ - 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
+ - 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
+ 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*
+ 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:
+ description: If the access-request was for granting or revoking access.
+ type: string
+ enum:
+ - GRANT_ACCESS
+ - REVOKE_ACCESS
+ example: GRANT_ACCESS
+ requester:
+ description: The identity that requested the item.
+ type: object
+ properties:
+ type:
+ description: DTO 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ example: IDENTITY
+ 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
+ requestedFor:
+ description: The identity for whom the item is requested for.
+ type: object
+ properties:
+ type:
+ description: DTO 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ example: IDENTITY
+ 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
+ reviewedBy:
+ description: The identity who has reviewed the approval.
+ type: object
+ properties:
+ type:
+ description: DTO 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ example: IDENTITY
+ 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
+ owner:
+ description: The owner or approver of the approval.
+ type: object
+ properties:
+ type:
+ description: DTO 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ example: IDENTITY
+ 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
+ requestedObject:
+ description: The requested access item.
+ 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:
+ description: The requester's comment.
+ type: object
+ properties:
+ comment:
+ type: string
+ description: Content of the comment
+ example: Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat
+ author:
+ 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure.
+ example: IDENTITY
+ id:
+ type: string
+ description: ID of the author
+ example: 2c91808568c529c60168cca6f90c1313
+ name:
+ type: string
+ description: Human-readable display name of the identity making the comment
+ example: Adam Kennedy
+ created:
+ type: string
+ format: date-time
+ description: Date and time comment was created
+ example: '2017-07-11T18:45:37.098Z'
+ reviewerComment:
+ description: The approval's reviewer's comment.
+ type: object
+ properties:
+ comment:
+ type: string
+ description: Content of the comment
+ example: Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat
+ author:
+ 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure.
+ example: IDENTITY
+ id:
+ type: string
+ description: ID of the author
+ example: 2c91808568c529c60168cca6f90c1313
+ name:
+ type: string
+ description: Human-readable display name of the identity making the comment
+ example: Adam Kennedy
+ created:
+ type: string
+ format: date-time
+ description: Date and time comment was created
+ example: '2017-07-11T18:45:37.098Z'
+ previousReviewersComments:
+ type: array
+ items:
+ type: object
+ properties:
+ comment:
+ type: string
+ description: Content of the comment
+ example: Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat
+ author:
+ 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure.
+ example: IDENTITY
+ id:
+ type: string
+ description: ID of the author
+ example: 2c91808568c529c60168cca6f90c1313
+ name:
+ type: string
+ description: Human-readable display name of the identity making the comment
+ example: Adam Kennedy
+ created:
+ type: string
+ format: date-time
+ description: Date and time comment was created
+ example: '2017-07-11T18:45:37.098Z'
+ description: The history of the previous reviewers comments.
+ forwardHistory:
+ type: array
+ items:
+ type: object
+ properties:
+ oldApproverName:
+ type: string
+ description: Display name of approver that forwarded the approval.
+ example: frank.mir
+ newApproverName:
+ type: string
+ description: Display name of approver to whom the approval was forwarded.
+ example: al.volta
+ comment:
+ type: string
+ description: Comment made by old approver when forwarding.
+ example: Fusce id orci vel consectetur amet ipsum quam.
+ modified:
+ type: string
+ format: date-time
+ description: Time at which approval was forwarded.
+ example: '2019-08-23T18:52:57.398Z'
+ description: The history of approval forward action.
+ commentRequiredWhenRejected:
+ type: boolean
+ description: When true the rejector has to provide comments when rejecting
+ example: true
+ state:
+ description: The final state of the approval
+ type: string
+ enum:
+ - APPROVED
+ - REJECTED
+ example: APPROVED
+ removeDate:
+ type: string
+ description: The date the role or access profile is no longer assigned to the specified identity.
+ format: date-time
+ example: '2020-07-11T00:00:00Z'
+ removeDateUpdateRequested:
+ type: boolean
+ 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'
+ sodViolationContext:
+ description: The details of the SOD violations for the associated approval.
+ type: object
+ properties:
+ state:
+ type: string
+ enum:
+ - SUCCESS
+ - ERROR
+ description: The status of SOD violation check
+ example: SUCCESS
+ uuid:
+ description: The id of the Violation check event
+ type: string
+ example: f73d16e9-a038-46c5-b217-1246e15fdbdd
+ violationCheckResult:
+ description: The inner object representing the completed SOD Violation check
+ type: object
+ properties:
+ message:
+ description: 'If the request failed, includes any error message that was generated.'
+ example:
+ - locale: en-US
+ localeOrigin: DEFAULT
+ text: An error has occurred during the SOD violation check
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ requestedAppName: test-app
+ requestedAppId: 2c91808f7892918f0178b78da4a305a1
+ violationContexts:
+ type: array
+ items:
+ description: The contextual information of the violated criteria
+ type: object
+ properties:
+ policy:
+ description: Reference to the Policy that is being violated.
+ type: object
+ properties:
+ type:
+ description: DTO 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ example: IDENTITY
+ 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
+ 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
+ example: true
+ description: If the entitlement already belonged to the user or not.
+ type:
+ example: ENTITLEMENT
+ 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure.
+ 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:
+ description: Details of the Entitlement criteria
+ type: object
+ properties:
+ existing:
+ type: boolean
+ example: true
+ description: If the entitlement already belonged to the user or not.
+ type:
+ example: ENTITLEMENT
+ 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure.
+ id:
+ type: string
+ description: Entitlement ID
+ example: 2c918085771e9d3301773b3cb66f6398
+ name:
+ type: string
+ description: Entitlement name
+ example: My HR Entitlement
+ violatedPolicies:
+ type: array
+ description: A list of the Policies that were violated
+ items:
+ description: Reference to the policy that was violated
+ example:
+ - type: SOD_POLICY
+ id: 69129440-422d-4a23-aadd-35c828d5bfda
+ name: HR Policy
+ type: object
+ properties:
+ type:
+ description: DTO 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ example: IDENTITY
+ 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
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '/access-request-approvals/{approvalId}/approve':
+ post:
+ operationId: approveRequest
+ summary: Approves an access request approval.
+ tags:
+ - Access Request Approvals
+ description: This endpoint approves 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
+ description: The id of the approval.
+ example: 2c91808b7294bea301729568c68c002e
+ requestBody:
+ description: Reviewer's comment.
+ required: false
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ comment:
+ type: string
+ description: Content of the comment
+ example: Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat
+ author:
+ 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure.
+ example: IDENTITY
+ id:
+ type: string
+ description: ID of the author
+ example: 2c91808568c529c60168cca6f90c1313
+ name:
+ type: string
+ description: Human-readable display name of the identity making the comment
+ example: Adam Kennedy
+ created:
+ type: string
+ format: date-time
+ description: Date and time comment was created
+ example: '2017-07-11T18:45:37.098Z'
+ responses:
+ '202':
+ description: Accepted - Returned if the request was successfully accepted into the system.
+ content:
+ application/json:
+ schema:
+ type: object
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '404':
+ description: Not Found - returned if the request URL refers to a resource or object that does not exist
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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':
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '/access-request-approvals/{approvalId}/reject':
+ post:
+ operationId: rejectRequest
+ summary: Rejects an access request approval.
+ tags:
+ - Access Request Approvals
+ description: This endpoint rejects 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
+ description: The id of the approval.
+ example: 2c91808b7294bea301729568c68c002e
+ requestBody:
+ description: Reviewer's comment.
+ required: false
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ comment:
+ type: string
+ description: Content of the comment
+ example: Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat
+ author:
+ 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure.
+ example: IDENTITY
+ id:
+ type: string
+ description: ID of the author
+ example: 2c91808568c529c60168cca6f90c1313
+ name:
+ type: string
+ description: Human-readable display name of the identity making the comment
+ example: Adam Kennedy
+ created:
+ type: string
+ format: date-time
+ description: Date and time comment was created
+ example: '2017-07-11T18:45:37.098Z'
+ responses:
+ '202':
+ description: Accepted - Returned if the request was successfully accepted into the system.
+ content:
+ application/json:
+ schema:
+ type: object
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '404':
+ description: Not Found - returned if the request URL refers to a resource or object that does not exist
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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':
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '/access-request-approvals/{approvalId}/forward':
+ post:
+ operationId: forwardRequest
+ summary: Forwards an access request approval.
+ tags:
+ - Access Request Approvals
+ description: This endpoint forwards an access request approval to a new owner. 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
+ description: The id of the approval.
+ 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: Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat
+ minLength: 1
+ maxLength: 255
+ comment:
+ type: string
+ description: The comment provided by the forwarder
+ example: 2c91808568c529c60168cca6f90c1313
+ minLength: 1
+ maxLength: 255
+ responses:
+ '202':
+ description: Accepted - Returned if the request was successfully accepted into the system.
+ content:
+ application/json:
+ schema:
+ type: object
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '404':
+ description: Not Found - returned if the request URL refers to a resource or object that does not exist
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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':
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ /access-request-approvals/approval-summary:
+ get:
+ operationId: approvalSummary
+ summary: Get the number of access-requests-approvals
+ tags:
+ - Access Request Approvals
+ description: 'This endpoint returns the number of pending, approved and rejected access requests approvals. See "owner-id" query parameter below for authorization 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
+ - in: query
+ name: from-date
+ schema:
+ type: string
+ description: From date is the date and time from which the results will be shown. It should be in a valid ISO-8601 format
+ example: 'from-date=2020-03-19T19:59:11Z'
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ /accounts:
+ get:
+ operationId: listAccounts
+ tags:
+ - Accounts
+ summary: Accounts List
+ description: |-
+ This returns a list of accounts.
+ A token with ORG_ADMIN authority is required to call this API.
+ security:
+ - oauth2:
+ - 'idn:account-list:read'
+ parameters:
+ - 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
+ - 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
+ 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*
+
+ **identityId**: *eq*
+
+ **name**: *eq, in*
+
+ **nativeIdentity**: *eq, in*
+
+ **sourceId**: *eq, in*
+
+ **uncorrelated**: *eq*
+ responses:
+ '200':
+ description: List of account objects
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ 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:17.000Z
+ format: date-time
+ readOnly: true
+ modified:
+ description: Last modification date of the Object
+ type: string
+ example: 2015-05-28T14:07:17.000Z
+ format: date-time
+ readOnly: true
+ - type: object
+ properties:
+ sourceId:
+ type: string
+ example: 2c9180835d2e5168015d32f890ca1581
+ identityId:
+ type: string
+ example: 2c9180835d2e5168015d32f890ca1581
+ attributes:
+ type: object
+ authoritative:
+ type: boolean
+ description:
+ type: string
+ disabled:
+ type: boolean
+ locked:
+ type: boolean
+ nativeIdentity:
+ type: string
+ systemAccount:
+ type: boolean
+ uncorrelated:
+ type: boolean
+ uuid:
+ type: string
+ manuallyCorrelated:
+ type: boolean
+ hasEntitlements:
+ type: boolean
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ post:
+ operationId: createAccount
+ tags:
+ - Accounts
+ summary: Create Account
+ description: |-
+ This API submits an account creation task and returns the task ID.
+ A token with ORG_ADMIN authority is required to call this API.
+ security:
+ - oauth2:
+ - 'idn:account:create'
+ 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':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '/accounts/{id}':
+ get:
+ operationId: getAccount
+ tags:
+ - Accounts
+ summary: Account Details
+ description: |-
+ This API returns the details for a single account based on the ID.
+ A token with ORG_ADMIN authority is required to call this API.
+ security:
+ - oauth2:
+ - 'idn:account:read'
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ required: true
+ description: The account ID
+ example: ef38f94347e94562b5bb8424a56397d8
+ responses:
+ '200':
+ description: An account object
+ content:
+ application/json:
+ schema:
+ 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:17.000Z
+ format: date-time
+ readOnly: true
+ modified:
+ description: Last modification date of the Object
+ type: string
+ example: 2015-05-28T14:07:17.000Z
+ format: date-time
+ readOnly: true
+ - type: object
+ properties:
+ sourceId:
+ type: string
+ example: 2c9180835d2e5168015d32f890ca1581
+ identityId:
+ type: string
+ example: 2c9180835d2e5168015d32f890ca1581
+ attributes:
+ type: object
+ authoritative:
+ type: boolean
+ description:
+ type: string
+ disabled:
+ type: boolean
+ locked:
+ type: boolean
+ nativeIdentity:
+ type: string
+ systemAccount:
+ type: boolean
+ uncorrelated:
+ type: boolean
+ uuid:
+ type: string
+ manuallyCorrelated:
+ type: boolean
+ hasEntitlements:
+ type: boolean
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '404':
+ description: Not Found - returned if the request URL refers to a resource or object that does not exist
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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':
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ patch:
+ operationId: updateAccount
+ tags:
+ - Accounts
+ summary: Update Account
+ description: |-
+ Use this API to modify the following fields:
+ * `identityId`
+
+ * `manuallyCorrelated`
+
+ >**NOTE: All other fields can not be modified.**
+
+ The request must provide a JSONPatch payload.
+
+ A token with ORG_ADMIN authority is required to call this API.
+ security:
+ - oauth2:
+ - 'idn:account:update'
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ required: true
+ description: The 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
+ example:
+ - op: replace
+ path: /identityId
+ value: 2c9180845d1edece015d27a975983e21
+ responses:
+ '202':
+ description: Accepted. Update request accepted and is in progress.
+ content:
+ application/json:
+ schema:
+ type: object
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '404':
+ description: Not Found - returned if the request URL refers to a resource or object that does not exist
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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':
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ put:
+ operationId: putAccount
+ tags:
+ - Accounts
+ summary: Update Account
+ description: |-
+ This API submits an account update task and returns the task ID.
+ A token with ORG_ADMIN authority is required to call this API.
+ >**NOTE: The PUT Account API is designated only for Delimited File sources.**
+ security:
+ - oauth2:
+ - 'idn:account:update'
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ required: true
+ description: The 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
+ 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:
+ 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':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '404':
+ description: Not Found - returned if the request URL refers to a resource or object that does not exist
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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':
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ delete:
+ operationId: deleteAccount
+ tags:
+ - Accounts
+ summary: Delete Account
+ description: |-
+ This API submits an account delete task and returns the task ID. This operation can only be used on Flat File Sources. Any attempt to execute this request on the source of other type will result in an error response with a status code of 400.
+ A token with ORG_ADMIN authority is required to call this API.
+ security:
+ - oauth2:
+ - 'idn:account:delete'
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ required: true
+ description: The account ID
+ example: ef38f94347e94562b5bb8424a56397d8
+ 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':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '404':
+ description: Not Found - returned if the request URL refers to a resource or object that does not exist
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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':
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '/accounts/{id}/entitlements':
+ get:
+ operationId: getAccountEntitlements
+ tags:
+ - Accounts
+ summary: Account Entitlements
+ description: |-
+ This API returns entitlements of the account.
+ A token with ORG_ADMIN authority is required to call this API.
+ security:
+ - oauth2:
+ - 'idn:account-entitlement:read'
+ parameters:
+ - 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
+ - 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: path
+ name: id
+ schema:
+ type: string
+ required: true
+ description: The account id
+ example: ef38f94347e94562b5bb8424a56397d8
+ responses:
+ '200':
+ description: An array of account entitlements
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ 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:17.000Z
+ format: date-time
+ readOnly: true
+ modified:
+ description: Last modification date of the Object
+ type: string
+ example: 2015-05-28T14:07:17.000Z
+ format: date-time
+ readOnly: true
+ - 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
+ attributes:
+ description: Entitlement attributes
+ type: object
+ 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
+ cloudGoverned:
+ description: Determines if this Entitlement is goverened in the cloud.
+ type: boolean
+ source:
+ description: Reference to the source this entitlment belongs to.
+ example:
+ - type: SOURCE
+ id: 2c9180835d191a86015d28455b4b232a
+ name: HR Active Directory
+ type: object
+ properties:
+ type:
+ description: DTO 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ example: IDENTITY
+ 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
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '404':
+ description: Not Found - returned if the request URL refers to a resource or object that does not exist
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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':
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '/accounts/{id}/reload':
+ post:
+ operationId: reloadAccount
+ tags:
+ - Accounts
+ summary: Reload Account
+ description: |-
+ This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process.
+ A token with ORG_ADMIN authority is required to call this API.
+ security:
+ - oauth2:
+ - 'idn:account:reload'
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ required: true
+ description: The account id
+ example: ef38f94347e94562b5bb8424a56397d8
+ 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':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '404':
+ description: Not Found - returned if the request URL refers to a resource or object that does not exist
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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':
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '/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.
+ A token with ORG_ADMIN authority is required to call this API.
+ security:
+ - oauth2:
+ - 'idn:account:enable'
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ required: true
+ 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:
+ 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':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '404':
+ description: Not Found - returned if the request URL refers to a resource or object that does not exist
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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':
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '/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.
+ A token with ORG_ADMIN authority is required to call this API.
+ security:
+ - oauth2:
+ - 'idn:account:disable'
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ required: true
+ 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:
+ 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':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '404':
+ description: Not Found - returned if the request URL refers to a resource or object that does not exist
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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':
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '/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.
+ A token with ORG_ADMIN authority is required to call this API.
+ security:
+ - oauth2:
+ - 'idn:account:unlock'
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ required: true
+ 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:
+ 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':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '404':
+ description: Not Found - returned if the request URL refers to a resource or object that does not exist
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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':
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ /account-activities:
+ get:
+ operationId: listAccountActivities
+ tags:
+ - Account Activities
+ summary: Get a list of 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
+ - 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
+ - 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
+ - in: query
+ name: type
+ schema:
+ type: string
+ description: The type of account activity.
+ required: false
+ - 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
+ - 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:
+ **type**: *eq, in*
+ **created**: *gt, lt, ge, le*
+ **modified**: *gt, lt, ge, le*
+ - 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**
+ 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 itself
+ example: 2c9180835d2e5168015d32f890ca1581
+ name:
+ type: string
+ example: 2c9180835d2e5168015d32f890ca1581
+ created:
+ type: string
+ format: date-time
+ example: '2017-07-11T18:45:37.098Z'
+ modified:
+ type: string
+ format: date-time
+ example: '2018-06-25T20:22:28.104Z'
+ completed:
+ type: string
+ format: date-time
+ nullable: true
+ example: '2018-10-19T13:49:37.385Z'
+ completionStatus:
+ nullable: true
+ type: string
+ enum:
+ - SUCCESS
+ - FAILURE
+ - INCOMPLETE
+ - PENDING
+ type:
+ type: string
+ example: appRequest
+ 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
+ targetIdentitySummary:
+ 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
+ errors:
+ nullable: true
+ 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
+ type: array
+ items:
+ type: string
+ example:
+ - 'Some warning, another warning'
+ items:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ description: Item id
+ example: 2725138ee34949beb0d6cc982d2d4625
+ name:
+ type: string
+ description: Human-readable display name of item
+ requested:
+ type: string
+ format: date-time
+ description: Date and time item was requested
+ example: '2017-07-11T18:45:37.098Z'
+ approvalStatus:
+ type: string
+ enum:
+ - FINISHED
+ - REJECTED
+ - RETURNED
+ - EXPIRED
+ - PENDING
+ - CANCELED
+ provisioningStatus:
+ type: string
+ enum:
+ - PENDING
+ - FINISHED
+ - UNVERIFIABLE
+ - COMMITED
+ - FAILED
+ - RETRY
+ description: Provisioning state of an account activity item
+ 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:
+ 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
+ reviewerComment:
+ 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'
+ operation:
+ type: string
+ enum:
+ - ADD
+ - CREATE
+ - MODIFY
+ - DELETE
+ - DISABLE
+ - ENABLE
+ - UNLOCK
+ - LOCK
+ - REMOVE
+ description: Represents an operation in an account activity item
+ 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:
+ type: string
+ enum:
+ - ACCESS_PROFILE
+ - ROLE
+ description: Enum represented the currently supported requestable object types. Additional values may be added in the future without notice.
+ example: ACCESS_PROFILE
+ 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'
+ removeDate:
+ nullable: true
+ type: string
+ description: The date the role or access profile is no longer assigned to the specified identity.
+ format: date-time
+ example: '2020-07-11T00:00:00Z'
+ executionStatus:
+ type: string
+ enum:
+ - EXECUTING
+ - VERIFYING
+ - TERMINATED
+ - COMPLETED
+ clientMetadata:
+ nullable: true
+ type: object
+ additionalProperties:
+ type: string
+ description: 'Arbitrary key-value pairs, if any were included in the corresponding access request'
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '/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
+ description: The account activity id
+ example: ef38f94347e94562b5bb8424a56397d8
+ responses:
+ '200':
+ description: An account activity object
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ id:
+ type: string
+ description: Id of the account activity itself
+ example: 2c9180835d2e5168015d32f890ca1581
+ name:
+ type: string
+ example: 2c9180835d2e5168015d32f890ca1581
+ created:
+ type: string
+ format: date-time
+ example: '2017-07-11T18:45:37.098Z'
+ modified:
+ type: string
+ format: date-time
+ example: '2018-06-25T20:22:28.104Z'
+ completed:
+ type: string
+ format: date-time
+ nullable: true
+ example: '2018-10-19T13:49:37.385Z'
+ completionStatus:
+ nullable: true
+ type: string
+ enum:
+ - SUCCESS
+ - FAILURE
+ - INCOMPLETE
+ - PENDING
+ type:
+ type: string
+ example: appRequest
+ 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
+ targetIdentitySummary:
+ 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
+ errors:
+ nullable: true
+ 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
+ type: array
+ items:
+ type: string
+ example:
+ - 'Some warning, another warning'
+ items:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ description: Item id
+ example: 2725138ee34949beb0d6cc982d2d4625
+ name:
+ type: string
+ description: Human-readable display name of item
+ requested:
+ type: string
+ format: date-time
+ description: Date and time item was requested
+ example: '2017-07-11T18:45:37.098Z'
+ approvalStatus:
+ type: string
+ enum:
+ - FINISHED
+ - REJECTED
+ - RETURNED
+ - EXPIRED
+ - PENDING
+ - CANCELED
+ provisioningStatus:
+ type: string
+ enum:
+ - PENDING
+ - FINISHED
+ - UNVERIFIABLE
+ - COMMITED
+ - FAILED
+ - RETRY
+ description: Provisioning state of an account activity item
+ 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:
+ 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
+ reviewerComment:
+ 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'
+ operation:
+ type: string
+ enum:
+ - ADD
+ - CREATE
+ - MODIFY
+ - DELETE
+ - DISABLE
+ - ENABLE
+ - UNLOCK
+ - LOCK
+ - REMOVE
+ description: Represents an operation in an account activity item
+ 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:
+ type: string
+ enum:
+ - ACCESS_PROFILE
+ - ROLE
+ description: Enum represented the currently supported requestable object types. Additional values may be added in the future without notice.
+ example: ACCESS_PROFILE
+ 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'
+ removeDate:
+ nullable: true
+ type: string
+ description: The date the role or access profile is no longer assigned to the specified identity.
+ format: date-time
+ example: '2020-07-11T00:00:00Z'
+ executionStatus:
+ type: string
+ enum:
+ - EXECUTING
+ - VERIFYING
+ - TERMINATED
+ - COMPLETED
+ clientMetadata:
+ nullable: true
+ type: object
+ additionalProperties:
+ type: string
+ description: 'Arbitrary key-value pairs, if any were included in the corresponding access request'
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '404':
+ description: Not Found - returned if the request URL refers to a resource or object that does not exist
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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':
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ /certifications:
+ get:
+ operationId: listIdentityCertifications
+ tags:
+ - Certifications
+ summary: Identity Campaign Certifications by IDs
+ description: 'This API returns a list of identity campaign certifications that satisfy the given 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
+ description: The ID of reviewer identity. *me* indicates the current user.
+ required: false
+ - 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
+ - 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*
+ **campaign.id**: *eq, in*
+ **phase**: *eq*
+ **completed**: *eq, ne*
+ - 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, 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
+ name:
+ example: 'Source Owner Access Review for Employees [source]'
+ type: string
+ campaign:
+ type: object
+ required:
+ - id
+ - name
+ - type
+ - campaignType
+ - description
+ 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
+ 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
+ identitiesTotal:
+ type: integer
+ description: 'The total number of identities in the Certification, both complete and incomplete.'
+ example: 10
+ created:
+ example: '2018-06-25T20:22:28.104Z'
+ format: date-time
+ type: string
+ modified:
+ example: '2018-06-25T20:22:28.104Z'
+ format: date-time
+ type: string
+ decisionsMade:
+ type: integer
+ description: The number of approve/revoke/acknowledge decisions that have been made.
+ example: 20
+ decisionsTotal:
+ type: integer
+ description: The total number of approve/revoke/acknowledge decisions.
+ example: 40
+ 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
+ created:
+ nullable: true
+ example: '2018-06-25T20:22:28.104Z'
+ format: date-time
+ type: string
+ modified:
+ nullable: true
+ example: '2018-06-25T20:22:28.104Z'
+ format: date-time
+ type: string
+ 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
+ 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
+ created:
+ nullable: true
+ example: '2018-06-25T20:22:28.104Z'
+ format: date-time
+ type: string
+ modified:
+ nullable: true
+ example: '2018-06-25T20:22:28.104Z'
+ format: date-time
+ type: string
+ comment:
+ type: string
+ description: The comment entered when the Certification was reassigned
+ example: Reassigned for a reason
+ hasErrors:
+ type: boolean
+ example: false
+ errorMessage:
+ 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
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '/certifications/{id}':
+ get:
+ operationId: getIdentityCertification
+ tags:
+ - Certifications
+ summary: Identity Certification by ID
+ description: This API returns a single identity campaign certification by its ID. 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
+ description: The certification id
+ example: ef38f94347e94562b5bb8424a56397d8
+ responses:
+ '200':
+ description: An identity campaign certification object
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ id:
+ example: 2c9180835d2e5168015d32f890ca1581
+ type: string
+ name:
+ example: 'Source Owner Access Review for Employees [source]'
+ type: string
+ campaign:
+ type: object
+ required:
+ - id
+ - name
+ - type
+ - campaignType
+ - description
+ 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
+ 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
+ identitiesTotal:
+ type: integer
+ description: 'The total number of identities in the Certification, both complete and incomplete.'
+ example: 10
+ created:
+ example: '2018-06-25T20:22:28.104Z'
+ format: date-time
+ type: string
+ modified:
+ example: '2018-06-25T20:22:28.104Z'
+ format: date-time
+ type: string
+ decisionsMade:
+ type: integer
+ description: The number of approve/revoke/acknowledge decisions that have been made.
+ example: 20
+ decisionsTotal:
+ type: integer
+ description: The total number of approve/revoke/acknowledge decisions.
+ example: 40
+ 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
+ created:
+ nullable: true
+ example: '2018-06-25T20:22:28.104Z'
+ format: date-time
+ type: string
+ modified:
+ nullable: true
+ example: '2018-06-25T20:22:28.104Z'
+ format: date-time
+ type: string
+ 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
+ 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
+ created:
+ nullable: true
+ example: '2018-06-25T20:22:28.104Z'
+ format: date-time
+ type: string
+ modified:
+ nullable: true
+ example: '2018-06-25T20:22:28.104Z'
+ format: date-time
+ type: string
+ comment:
+ type: string
+ description: The comment entered when the Certification was reassigned
+ example: Reassigned for a reason
+ hasErrors:
+ type: boolean
+ example: false
+ errorMessage:
+ 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
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '404':
+ description: Not Found - returned if the request URL refers to a resource or object that does not exist
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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':
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '/certifications/{id}/access-review-items':
+ get:
+ operationId: listIdentityAccessReviewItems
+ tags:
+ - Certifications
+ summary: List of Access Review Items
+ description: This API returns a list of access review items for an identity campaign certification. 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
+ description: The identity campaign certification ID
+ example: ef38f94347e94562b5bb8424a56397d8
+ - 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
+ - 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*
+
+ **type / 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*
+ - 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: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName**
+ - in: query
+ name: entitlements
+ schema:
+ type: string
+ 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
+ schema:
+ type: string
+ 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
+ schema:
+ type: string
+ 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:
+ type: object
+ description: An object holding the access that is being reviewed
+ properties:
+ access:
+ type: object
+ properties:
+ type:
+ description: The type of item being certified
+ 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ example: IDENTITY
+ 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
+ description: Indicates if the entitlement is a privileged entitlement
+ owner:
+ 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: Human-readable display name of identity. This is read-only
+ example: Alison Ferguso
+ email:
+ type: string
+ description: Email address of identity. This is read-only
+ example: alison.ferguso@identitysoon.com
+ 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
+ hasPermissions:
+ type: boolean
+ description: Indicates if the entitlement has permissions
+ example: false
+ isPermission:
+ type: boolean
+ description: Indicates if the entitlement is a representation of an account permission
+ example: false
+ revocable:
+ type: boolean
+ description: Indicates whether the entitlement can be revoked
+ example: true
+ cloudGoverned:
+ type: boolean
+ description: True if the entitlement is cloud governed
+ 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
+ example: false
+ description: Indicates whether this account is currently disabled
+ locked:
+ type: boolean
+ example: false
+ description: Indicates whether this account is currently locked
+ 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure.
+ example: IDENTITY
+ id:
+ nullable: true
+ type: string
+ description: The id associated with the account
+ example: 2c9180857182305e0171993737eb29e6
+ name:
+ nullable: true
+ type: string
+ 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'
+ 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
+ cloudGoverned:
+ type: boolean
+ description: True if the entitlement is cloud governed
+ 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:
+ description: Owner of the Access Profile
+ 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: Human-readable display name of identity. This is read-only
+ example: Alison Ferguso
+ email:
+ type: string
+ description: Email address of identity. This is read-only
+ example: alison.ferguso@identitysoon.com
+ entitlements:
+ type: array
+ description: A list of entitlements associated with this Access Profile
+ items:
+ 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
+ description: Indicates if the entitlement is a privileged entitlement
+ owner:
+ 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: Human-readable display name of identity. This is read-only
+ example: Alison Ferguso
+ email:
+ type: string
+ description: Email address of identity. This is read-only
+ example: alison.ferguso@identitysoon.com
+ 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
+ hasPermissions:
+ type: boolean
+ description: Indicates if the entitlement has permissions
+ example: false
+ isPermission:
+ type: boolean
+ description: Indicates if the entitlement is a representation of an account permission
+ example: false
+ revocable:
+ type: boolean
+ description: Indicates whether the entitlement can be revoked
+ example: true
+ cloudGoverned:
+ type: boolean
+ description: True if the entitlement is cloud governed
+ 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
+ example: false
+ description: Indicates whether this account is currently disabled
+ locked:
+ type: boolean
+ example: false
+ description: Indicates whether this account is currently locked
+ 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure.
+ example: IDENTITY
+ id:
+ nullable: true
+ type: string
+ description: The id associated with the account
+ example: 2c9180857182305e0171993737eb29e6
+ name:
+ nullable: true
+ type: string
+ 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'
+ 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
+ owner:
+ 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: Human-readable display name of identity. This is read-only
+ example: Alison Ferguso
+ email:
+ type: string
+ description: Email address of identity. This is read-only
+ example: alison.ferguso@identitysoon.com
+ revocable:
+ type: boolean
+ description: Indicates whether the Role can be revoked or requested
+ 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:
+ 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
+ cloudGoverned:
+ type: boolean
+ description: True if the entitlement is cloud governed
+ 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:
+ description: Owner of the Access Profile
+ 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: Human-readable display name of identity. This is read-only
+ example: Alison Ferguso
+ email:
+ type: string
+ description: Email address of identity. This is read-only
+ example: alison.ferguso@identitysoon.com
+ entitlements:
+ type: array
+ description: A list of entitlements associated with this Access Profile
+ items:
+ 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
+ description: Indicates if the entitlement is a privileged entitlement
+ owner:
+ 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: Human-readable display name of identity. This is read-only
+ example: Alison Ferguso
+ email:
+ type: string
+ description: Email address of identity. This is read-only
+ example: alison.ferguso@identitysoon.com
+ 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
+ hasPermissions:
+ type: boolean
+ description: Indicates if the entitlement has permissions
+ example: false
+ isPermission:
+ type: boolean
+ description: Indicates if the entitlement is a representation of an account permission
+ example: false
+ revocable:
+ type: boolean
+ description: Indicates whether the entitlement can be revoked
+ example: true
+ cloudGoverned:
+ type: boolean
+ description: True if the entitlement is cloud governed
+ 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
+ example: false
+ description: Indicates whether this account is currently disabled
+ locked:
+ type: boolean
+ example: false
+ description: Indicates whether this account is currently locked
+ 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure.
+ example: IDENTITY
+ id:
+ nullable: true
+ type: string
+ description: The id associated with the account
+ example: 2c9180857182305e0171993737eb29e6
+ name:
+ nullable: true
+ type: string
+ 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'
+ 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'
+ identitySummary:
+ 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
+ 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
+ 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
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '404':
+ description: Not Found - returned if the request URL refers to a resource or object that does not exist
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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':
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '/certifications/{id}/decide':
+ post:
+ operationId: makeIdentityDecision
+ tags:
+ - Certifications
+ summary: Decide on a Certification Item
+ description: The API makes a decision to approve or revoke one or more identity campaign certification items. 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
+ 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
+ example: ef38f94347e94562b5bb8424a56397d8
+ decision:
+ type: string
+ description: The decision to approve or revoke the review item
+ enum:
+ - APPROVE
+ - REVOKE
+ example: APPROVE
+ proposedEndDate:
+ type: string
+ format: date-time
+ 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:
+ nullable: true
+ 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.
+ reasons:
+ type: array
+ items:
+ type: string
+ description: A list of reasons for the recommendation.
+ 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:
+ type: object
+ properties:
+ id:
+ example: 2c9180835d2e5168015d32f890ca1581
+ type: string
+ name:
+ example: 'Source Owner Access Review for Employees [source]'
+ type: string
+ campaign:
+ type: object
+ required:
+ - id
+ - name
+ - type
+ - campaignType
+ - description
+ 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
+ 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
+ identitiesTotal:
+ type: integer
+ description: 'The total number of identities in the Certification, both complete and incomplete.'
+ example: 10
+ created:
+ example: '2018-06-25T20:22:28.104Z'
+ format: date-time
+ type: string
+ modified:
+ example: '2018-06-25T20:22:28.104Z'
+ format: date-time
+ type: string
+ decisionsMade:
+ type: integer
+ description: The number of approve/revoke/acknowledge decisions that have been made.
+ example: 20
+ decisionsTotal:
+ type: integer
+ description: The total number of approve/revoke/acknowledge decisions.
+ example: 40
+ 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
+ created:
+ nullable: true
+ example: '2018-06-25T20:22:28.104Z'
+ format: date-time
+ type: string
+ modified:
+ nullable: true
+ example: '2018-06-25T20:22:28.104Z'
+ format: date-time
+ type: string
+ 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
+ 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
+ created:
+ nullable: true
+ example: '2018-06-25T20:22:28.104Z'
+ format: date-time
+ type: string
+ modified:
+ nullable: true
+ example: '2018-06-25T20:22:28.104Z'
+ format: date-time
+ type: string
+ comment:
+ type: string
+ description: The comment entered when the Certification was reassigned
+ example: Reassigned for a reason
+ hasErrors:
+ type: boolean
+ example: false
+ errorMessage:
+ 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
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '404':
+ description: Not Found - returned if the request URL refers to a resource or object that does not exist
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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':
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '/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
+ description: The identity campaign certification ID
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ 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
+ enum:
+ - TARGET_SUMMARY
+ - ITEM
+ - IDENTITY_SUMMARY
+ 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
+ responses:
+ '200':
+ description: An identity campaign certification details after completing the reassignment.
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ id:
+ example: 2c9180835d2e5168015d32f890ca1581
+ type: string
+ name:
+ example: 'Source Owner Access Review for Employees [source]'
+ type: string
+ campaign:
+ type: object
+ required:
+ - id
+ - name
+ - type
+ - campaignType
+ - description
+ 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
+ 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
+ identitiesTotal:
+ type: integer
+ description: 'The total number of identities in the Certification, both complete and incomplete.'
+ example: 10
+ created:
+ example: '2018-06-25T20:22:28.104Z'
+ format: date-time
+ type: string
+ modified:
+ example: '2018-06-25T20:22:28.104Z'
+ format: date-time
+ type: string
+ decisionsMade:
+ type: integer
+ description: The number of approve/revoke/acknowledge decisions that have been made.
+ example: 20
+ decisionsTotal:
+ type: integer
+ description: The total number of approve/revoke/acknowledge decisions.
+ example: 40
+ 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
+ created:
+ nullable: true
+ example: '2018-06-25T20:22:28.104Z'
+ format: date-time
+ type: string
+ modified:
+ nullable: true
+ example: '2018-06-25T20:22:28.104Z'
+ format: date-time
+ type: string
+ 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
+ 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
+ created:
+ nullable: true
+ example: '2018-06-25T20:22:28.104Z'
+ format: date-time
+ type: string
+ modified:
+ nullable: true
+ example: '2018-06-25T20:22:28.104Z'
+ format: date-time
+ type: string
+ comment:
+ type: string
+ description: The comment entered when the Certification was reassigned
+ example: Reassigned for a reason
+ hasErrors:
+ type: boolean
+ example: false
+ errorMessage:
+ 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
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '404':
+ description: Not Found - returned if the request URL refers to a resource or object that does not exist
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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':
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '/certifications/{id}/sign-off':
+ post:
+ operationId: signOffIdentityCertification
+ tags:
+ - Certifications
+ summary: Finalize Identity Certification Decisions
+ description: This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. 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
+ description: The identity campaign certification ID
+ example: ef38f94347e94562b5bb8424a56397d8
+ responses:
+ '200':
+ description: An identity campaign certification object
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ id:
+ example: 2c9180835d2e5168015d32f890ca1581
+ type: string
+ name:
+ example: 'Source Owner Access Review for Employees [source]'
+ type: string
+ campaign:
+ type: object
+ required:
+ - id
+ - name
+ - type
+ - campaignType
+ - description
+ 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
+ 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
+ identitiesTotal:
+ type: integer
+ description: 'The total number of identities in the Certification, both complete and incomplete.'
+ example: 10
+ created:
+ example: '2018-06-25T20:22:28.104Z'
+ format: date-time
+ type: string
+ modified:
+ example: '2018-06-25T20:22:28.104Z'
+ format: date-time
+ type: string
+ decisionsMade:
+ type: integer
+ description: The number of approve/revoke/acknowledge decisions that have been made.
+ example: 20
+ decisionsTotal:
+ type: integer
+ description: The total number of approve/revoke/acknowledge decisions.
+ example: 40
+ 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
+ created:
+ nullable: true
+ example: '2018-06-25T20:22:28.104Z'
+ format: date-time
+ type: string
+ modified:
+ nullable: true
+ example: '2018-06-25T20:22:28.104Z'
+ format: date-time
+ type: string
+ 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
+ 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
+ created:
+ nullable: true
+ example: '2018-06-25T20:22:28.104Z'
+ format: date-time
+ type: string
+ modified:
+ nullable: true
+ example: '2018-06-25T20:22:28.104Z'
+ format: date-time
+ type: string
+ comment:
+ type: string
+ description: The comment entered when the Certification was reassigned
+ example: Reassigned for a reason
+ hasErrors:
+ type: boolean
+ example: false
+ errorMessage:
+ 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
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '404':
+ description: Not Found - returned if the request URL refers to a resource or object that does not exist
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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':
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '/certifications/{id}/decision-summary':
+ get:
+ operationId: getIdentityDecisionSummary
+ tags:
+ - Certification Summaries
+ summary: Summary of Certification Decisions
+ description: This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ required: true
+ description: The certification ID
+ example: ef38f94347e94562b5bb8424a56397d8
+ - in: query
+ name: filters
+ schema:
+ type: string
+ description: |-
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki-API-Standard-Collection-Parameters/ta-p/156407)
+
+ 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
+ accessProfileDecisionsMade:
+ type: integer
+ description: Number of access profile decisions that have been made
+ example: 5
+ roleDecisionsMade:
+ type: integer
+ description: Number of role decisions that have been made
+ example: 2
+ accountDecisionsMade:
+ type: integer
+ description: Number of account decisions that have been made
+ example: 4
+ entitlementDecisionsTotal:
+ type: integer
+ description: 'The total number of entitlement decisions on the certification, both complete and incomplete'
+ example: 6
+ accessProfileDecisionsTotal:
+ type: integer
+ description: 'The total number of access profile decisions on the certification, both complete and incomplete'
+ example: 10
+ roleDecisionsTotal:
+ type: integer
+ description: 'The total number of role decisions on the certification, both complete and incomplete'
+ example: 4
+ accountDecisionsTotal:
+ type: integer
+ description: 'The total number of account decisions on the certification, both complete and incomplete'
+ example: 8
+ entitlementsApproved:
+ type: integer
+ description: The number of entitlement decisions that have been made which were approved
+ example: 2
+ entitlementsRevoked:
+ type: integer
+ description: The number of entitlement decisions that have been made which were revoked
+ example: 1
+ accessProfilesApproved:
+ type: integer
+ description: The number of access profile decisions that have been made which were approved
+ example: 3
+ accessProfilesRevoked:
+ type: integer
+ description: The number of access profile decisions that have been made which were revoked
+ example: 2
+ rolesApproved:
+ type: integer
+ description: The number of role decisions that have been made which were approved
+ example: 2
+ rolesRevoked:
+ type: integer
+ description: The number of role decisions that have been made which were revoked
+ example: 0
+ accountsApproved:
+ type: integer
+ description: The number of account decisions that have been made which were approved
+ example: 1
+ accountsRevoked:
+ type: integer
+ description: The number of account decisions that have been made which were revoked
+ example: 3
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '404':
+ description: Not Found - returned if the request URL refers to a resource or object that does not exist
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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':
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '/certifications/{id}/identity-summaries':
+ get:
+ operationId: getIdentitySummaries
+ tags:
+ - Certification Summaries
+ summary: Identity Summaries for Identity Campaign Certification
+ description: This API returns a list of the identity summaries for a specific identity campaign certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ required: true
+ description: The identity campaign certification ID
+ example: ef38f94347e94562b5bb8424a56397d8
+ - 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
+ - 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*
+
+ **completed**: *eq, ne*
+
+ **name**: *eq, sw*
+ - 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**
+ 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:
+ - id: 2c91808772a504f50172a9540e501ba7
+ name: Aaron Grey
+ identityId: 2c9180857182306001719937379633e4
+ completed: false
+ - id: 2c91808772a504f50172a9540e501ba8
+ name: Aglae Wilson
+ identityId: 2c9180857182306001719937377a33de
+ completed: true
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '404':
+ description: Not Found - returned if the request URL refers to a resource or object that does not exist
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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':
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '/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. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ required: true
+ 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
+ - 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
+ - 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://community.sailpoint.com/t5/IdentityNow-Wiki-API-Standard-Collection-Parameters/ta-p/156407)
+
+ 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
+ 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: **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:
+ description: The type of item being certified
+ 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ example: IDENTITY
+ 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
+ description: Indicates if the entitlement is a privileged entitlement
+ owner:
+ 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: Human-readable display name of identity. This is read-only
+ example: Alison Ferguso
+ email:
+ type: string
+ description: Email address of identity. This is read-only
+ example: alison.ferguso@identitysoon.com
+ 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
+ hasPermissions:
+ type: boolean
+ description: Indicates if the entitlement has permissions
+ example: false
+ isPermission:
+ type: boolean
+ description: Indicates if the entitlement is a representation of an account permission
+ example: false
+ revocable:
+ type: boolean
+ description: Indicates whether the entitlement can be revoked
+ example: true
+ cloudGoverned:
+ type: boolean
+ description: True if the entitlement is cloud governed
+ 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
+ example: false
+ description: Indicates whether this account is currently disabled
+ locked:
+ type: boolean
+ example: false
+ description: Indicates whether this account is currently locked
+ 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure.
+ example: IDENTITY
+ id:
+ nullable: true
+ type: string
+ description: The id associated with the account
+ example: 2c9180857182305e0171993737eb29e6
+ name:
+ nullable: true
+ type: string
+ 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'
+ 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
+ cloudGoverned:
+ type: boolean
+ description: True if the entitlement is cloud governed
+ 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:
+ description: Owner of the Access Profile
+ 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: Human-readable display name of identity. This is read-only
+ example: Alison Ferguso
+ email:
+ type: string
+ description: Email address of identity. This is read-only
+ example: alison.ferguso@identitysoon.com
+ entitlements:
+ type: array
+ description: A list of entitlements associated with this Access Profile
+ items:
+ 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
+ description: Indicates if the entitlement is a privileged entitlement
+ owner:
+ 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: Human-readable display name of identity. This is read-only
+ example: Alison Ferguso
+ email:
+ type: string
+ description: Email address of identity. This is read-only
+ example: alison.ferguso@identitysoon.com
+ 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
+ hasPermissions:
+ type: boolean
+ description: Indicates if the entitlement has permissions
+ example: false
+ isPermission:
+ type: boolean
+ description: Indicates if the entitlement is a representation of an account permission
+ example: false
+ revocable:
+ type: boolean
+ description: Indicates whether the entitlement can be revoked
+ example: true
+ cloudGoverned:
+ type: boolean
+ description: True if the entitlement is cloud governed
+ 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
+ example: false
+ description: Indicates whether this account is currently disabled
+ locked:
+ type: boolean
+ example: false
+ description: Indicates whether this account is currently locked
+ 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure.
+ example: IDENTITY
+ id:
+ nullable: true
+ type: string
+ description: The id associated with the account
+ example: 2c9180857182305e0171993737eb29e6
+ name:
+ nullable: true
+ type: string
+ 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'
+ 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
+ owner:
+ 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: Human-readable display name of identity. This is read-only
+ example: Alison Ferguso
+ email:
+ type: string
+ description: Email address of identity. This is read-only
+ example: alison.ferguso@identitysoon.com
+ revocable:
+ type: boolean
+ description: Indicates whether the Role can be revoked or requested
+ 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:
+ 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
+ cloudGoverned:
+ type: boolean
+ description: True if the entitlement is cloud governed
+ 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:
+ description: Owner of the Access Profile
+ 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: Human-readable display name of identity. This is read-only
+ example: Alison Ferguso
+ email:
+ type: string
+ description: Email address of identity. This is read-only
+ example: alison.ferguso@identitysoon.com
+ entitlements:
+ type: array
+ description: A list of entitlements associated with this Access Profile
+ items:
+ 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
+ description: Indicates if the entitlement is a privileged entitlement
+ owner:
+ 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: Human-readable display name of identity. This is read-only
+ example: Alison Ferguso
+ email:
+ type: string
+ description: Email address of identity. This is read-only
+ example: alison.ferguso@identitysoon.com
+ 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
+ hasPermissions:
+ type: boolean
+ description: Indicates if the entitlement has permissions
+ example: false
+ isPermission:
+ type: boolean
+ description: Indicates if the entitlement is a representation of an account permission
+ example: false
+ revocable:
+ type: boolean
+ description: Indicates whether the entitlement can be revoked
+ example: true
+ cloudGoverned:
+ type: boolean
+ description: True if the entitlement is cloud governed
+ 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
+ example: false
+ description: Indicates whether this account is currently disabled
+ locked:
+ type: boolean
+ example: false
+ description: Indicates whether this account is currently locked
+ 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure.
+ example: IDENTITY
+ id:
+ nullable: true
+ type: string
+ description: The id associated with the account
+ example: 2c9180857182305e0171993737eb29e6
+ name:
+ nullable: true
+ type: string
+ 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'
+ 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'
+ 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
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '404':
+ description: Not Found - returned if the request URL refers to a resource or object that does not exist
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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':
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '/certifications/{id}/identity-summary/{identitySummaryId}':
+ get:
+ operationId: getIdentitySummary
+ tags:
+ - Certification Summaries
+ summary: Summary for Identity
+ description: This API returns the summary for an identity on a specified identity campaign certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ required: true
+ description: The identity campaign certification ID
+ example: ef38f94347e94562b5bb8424a56397d8
+ - in: path
+ name: identitySummaryId
+ schema:
+ type: string
+ required: true
+ description: The identity summary ID
+ example: 2c91808772a504f50172a9540e501ba8
+ responses:
+ '200':
+ description: An identity summary
+ content:
+ application/json:
+ schema:
+ 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
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '404':
+ description: Not Found - returned if the request URL refers to a resource or object that does not exist
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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':
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '/identities/{identity-id}/set-lifecycle-state':
+ post:
+ operationId: setLifecycleState
+ tags:
+ - Lifecycle States
+ summary: Set Lifecycle State
+ description: |-
+ This endpoint will set/update an identity's lifecycle state to the one provided and updates the corresponding Identity Profile.
+ A token with ORG_ADMIN or API authority is required to call this API.
+ security:
+ - oauth2:
+ - 'idn:identity-lifecycle-state:update'
+ parameters:
+ - in: path
+ name: identity-id
+ description: The ID of the identity to update
+ required: true
+ example: 2c9180857893f1290178944561990364
+ schema:
+ type: string
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ lifecycleStateId:
+ type: string
+ description: The 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: The ID of the IdentityRequest object that was generated when the workflow launches
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '404':
+ description: Not Found - returned if the request URL refers to a resource or object that does not exist
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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':
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '/identity-profiles/{identity-profile-id}/lifecycle-states':
+ get:
+ operationId: listLifecycleStates
+ tags:
+ - Lifecycle States
+ summary: Lists LifecycleStates
+ description: |-
+ This end-point lists all the LifecycleStates associated with IdentityProfiles.
+ A token with API, or ORG_ADMIN authority is required to call this API.
+ security:
+ - oauth2:
+ - 'idn:identity-profile-lifecycle-state:read'
+ parameters:
+ - in: path
+ name: identity-profile-id
+ description: The IdentityProfile id
+ required: true
+ schema:
+ type: string
+ - 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
+ - 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: 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**
+ responses:
+ '200':
+ description: List of LifecycleState objects
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ 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:17.000Z
+ format: date-time
+ readOnly: true
+ modified:
+ description: Last modification date of the Object
+ type: string
+ example: 2015-05-28T14:07:17.000Z
+ format: date-time
+ readOnly: true
+ - type: object
+ required:
+ - technicalName
+ properties:
+ enabled:
+ type: boolean
+ example: true
+ description: Whether the lifecycle state is enabled or disabled.
+ technicalName:
+ type: string
+ example: Technical Name
+ description: The technical name for lifecycle state. This is for internal use.
+ description:
+ type: string
+ example: Lifecycle description
+ description: Lifecycle state 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
+ example: true
+ description: 'If true, then the manager is notified of the lifecycle state change.'
+ notifyAllAdmins:
+ type: boolean
+ example: true
+ description: 'If true, then all the admins are notified of the lifecycle state change.'
+ notifySpecificUsers:
+ type: boolean
+ 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.
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ post:
+ operationId: createLifecycleState
+ tags:
+ - Lifecycle States
+ summary: Create Lifecycle State
+ description: |-
+ This API creates a new Lifecycle State.
+ A token with ORG_ADMIN or API authority is required to call this API.
+ security:
+ - oauth2:
+ - 'idn:identity-profile-lifecycle-state:create'
+ parameters:
+ - in: path
+ name: identity-profile-id
+ description: Identity Profile ID
+ required: true
+ schema:
+ type: string
+ requestBody:
+ description: Lifecycle State
+ required: true
+ content:
+ application/json:
+ schema:
+ 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:17.000Z
+ format: date-time
+ readOnly: true
+ modified:
+ description: Last modification date of the Object
+ type: string
+ example: 2015-05-28T14:07:17.000Z
+ format: date-time
+ readOnly: true
+ - type: object
+ required:
+ - technicalName
+ properties:
+ enabled:
+ type: boolean
+ example: true
+ description: Whether the lifecycle state is enabled or disabled.
+ technicalName:
+ type: string
+ example: Technical Name
+ description: The technical name for lifecycle state. This is for internal use.
+ description:
+ type: string
+ example: Lifecycle description
+ description: Lifecycle state 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
+ example: true
+ description: 'If true, then the manager is notified of the lifecycle state change.'
+ notifyAllAdmins:
+ type: boolean
+ example: true
+ description: 'If true, then all the admins are notified of the lifecycle state change.'
+ notifySpecificUsers:
+ type: boolean
+ 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.
+ responses:
+ '201':
+ description: Created LifecycleState object.
+ content:
+ application/json:
+ schema:
+ 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:17.000Z
+ format: date-time
+ readOnly: true
+ modified:
+ description: Last modification date of the Object
+ type: string
+ example: 2015-05-28T14:07:17.000Z
+ format: date-time
+ readOnly: true
+ - type: object
+ required:
+ - technicalName
+ properties:
+ enabled:
+ type: boolean
+ example: true
+ description: Whether the lifecycle state is enabled or disabled.
+ technicalName:
+ type: string
+ example: Technical Name
+ description: The technical name for lifecycle state. This is for internal use.
+ description:
+ type: string
+ example: Lifecycle description
+ description: Lifecycle state 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
+ example: true
+ description: 'If true, then the manager is notified of the lifecycle state change.'
+ notifyAllAdmins:
+ type: boolean
+ example: true
+ description: 'If true, then all the admins are notified of the lifecycle state change.'
+ notifySpecificUsers:
+ type: boolean
+ 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.
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}':
+ get:
+ operationId: getLifecycleState
+ tags:
+ - Lifecycle States
+ summary: Retrieves Lifecycle State
+ description: |-
+ This endpoint retrieves a Lifecycle State.
+ A token with ORG_ADMIN or API authority is required to call this API.
+ security:
+ - oauth2:
+ - 'idn:identity-profile-lifecycle-state:read'
+ parameters:
+ - in: path
+ name: identity-profile-id
+ description: Identity Profile ID
+ required: true
+ schema:
+ type: string
+ - in: path
+ name: lifecycle-state-id
+ description: Lifecycle State ID
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
+ description: The requested LifecycleState was successfully retrieved.
+ content:
+ application/json:
+ schema:
+ 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:17.000Z
+ format: date-time
+ readOnly: true
+ modified:
+ description: Last modification date of the Object
+ type: string
+ example: 2015-05-28T14:07:17.000Z
+ format: date-time
+ readOnly: true
+ - type: object
+ required:
+ - technicalName
+ properties:
+ enabled:
+ type: boolean
+ example: true
+ description: Whether the lifecycle state is enabled or disabled.
+ technicalName:
+ type: string
+ example: Technical Name
+ description: The technical name for lifecycle state. This is for internal use.
+ description:
+ type: string
+ example: Lifecycle description
+ description: Lifecycle state 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
+ example: true
+ description: 'If true, then the manager is notified of the lifecycle state change.'
+ notifyAllAdmins:
+ type: boolean
+ example: true
+ description: 'If true, then all the admins are notified of the lifecycle state change.'
+ notifySpecificUsers:
+ type: boolean
+ 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.
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '404':
+ description: Not Found - returned if the request URL refers to a resource or object that does not exist
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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':
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ patch:
+ operationId: updateLifecycleStates
+ tags:
+ - Lifecycle States
+ summary: Update Lifecycle State
+ description: |-
+ This endpoint updates individual Lifecycle State fields using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
+ A token with ORG_ADMIN or API authority is required to call this API.
+ security:
+ - oauth2:
+ - 'idn:identity-profile-lifecycle-state:update'
+ parameters:
+ - in: path
+ name: identity-profile-id
+ description: Identity Profile ID
+ required: true
+ schema:
+ type: string
+ - in: path
+ name: lifecycle-state-id
+ description: Lifecycle State ID
+ required: true
+ schema:
+ type: string
+ 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:
+ 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:
+ anyOf:
+ - type: string
+ - type: integer
+ - type: object
+ - type: array
+ items:
+ anyOf:
+ - type: string
+ - type: integer
+ - type: object
+ description: 'The value to be used for the operation, required for "add" and "replace" operations'
+ example: New description
+ 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:
+ 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:17.000Z
+ format: date-time
+ readOnly: true
+ modified:
+ description: Last modification date of the Object
+ type: string
+ example: 2015-05-28T14:07:17.000Z
+ format: date-time
+ readOnly: true
+ - type: object
+ required:
+ - technicalName
+ properties:
+ enabled:
+ type: boolean
+ example: true
+ description: Whether the lifecycle state is enabled or disabled.
+ technicalName:
+ type: string
+ example: Technical Name
+ description: The technical name for lifecycle state. This is for internal use.
+ description:
+ type: string
+ example: Lifecycle description
+ description: Lifecycle state 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
+ example: true
+ description: 'If true, then the manager is notified of the lifecycle state change.'
+ notifyAllAdmins:
+ type: boolean
+ example: true
+ description: 'If true, then all the admins are notified of the lifecycle state change.'
+ notifySpecificUsers:
+ type: boolean
+ 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.
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '404':
+ description: Not Found - returned if the request URL refers to a resource or object that does not exist
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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':
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ delete:
+ operationId: deleteLifecycleState
+ tags:
+ - Lifecycle States
+ summary: Delete Lifecycle State by ID
+ description: |-
+ This endpoint deletes the Lifecycle State using it's ID.
+ A token with API, or ORG_ADMIN authority is required to call this API.
+ security:
+ - oauth2:
+ - 'idn:identity-profile-lifecycle-state:delete'
+ parameters:
+ - in: path
+ name: identity-profile-id
+ description: Identity Profile ID
+ required: true
+ schema:
+ type: string
+ - in: path
+ name: lifecycle-state-id
+ description: Lifecycle State ID
+ required: true
+ schema:
+ type: string
+ responses:
+ '202':
+ description: The request was successfully accepted into the system.
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ type:
+ description: DTO 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ example: IDENTITY
+ 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
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '404':
+ description: Not Found - returned if the request URL refers to a resource or object that does not exist
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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':
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ /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.
+ A token with ORG_ADMIN or API authority is required to call this API to get a list of Identity Profiles.
+ parameters:
+ - 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
+ - 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, ne*
+
+ **name**: *eq, ne*
+
+ **priority**: *eq, ne*
+ - 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**, **priority**
+ responses:
+ '200':
+ description: List of identityProfiles.
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ allOf:
+ - type: object
+ properties:
+ type:
+ description: DTO 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ example: IDENTITY
+ 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
+ - type: object
+ properties:
+ description:
+ type: string
+ description: The description of the Identity Profile.
+ example: My custom flat file profile
+ owner:
+ description: The owner of the Identity Profile.
+ type: object
+ properties:
+ type:
+ description: DTO 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ example: IDENTITY
+ 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
+ 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
+ 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
+ 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:
+ description: The seaspray transformation definition.
+ type: object
+ properties:
+ type:
+ type: string
+ description: The type of the transform definition.
+ example: accountAttribute
+ attributes:
+ type: object
+ additionalProperties:
+ type: object
+ description: Arbitrary key-value pairs to store any metadata for the object
+ example:
+ attributeName: e-mail
+ sourceName: MySource
+ sourceId: 2c9180877a826e68017a8c0b03da1a53
+ identityExceptionReportReference:
+ type: object
+ properties:
+ taskResultId:
+ type: string
+ format: uuid
+ description: The id of the task result.
+ example: 2c918086795cd09201795d5f7d7533df
+ 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
+ example: true
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ - oauth2:
+ - 'idn:identity-profile:read'
+ /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:
+ - 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
+ - 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, ne*
+
+ **name**: *eq, ne*
+
+ **priority**: *eq, ne*
+ - 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**, **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.
+ self:
+ type: object
+ properties:
+ type:
+ description: DTO 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ example: IDENTITY
+ 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
+ object:
+ allOf:
+ - type: object
+ properties:
+ type:
+ description: DTO 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ example: IDENTITY
+ 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
+ - type: object
+ properties:
+ description:
+ type: string
+ description: The description of the Identity Profile.
+ example: My custom flat file profile
+ owner:
+ description: The owner of the Identity Profile.
+ type: object
+ properties:
+ type:
+ description: DTO 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ example: IDENTITY
+ 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
+ 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
+ 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
+ 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:
+ description: The seaspray transformation definition.
+ type: object
+ properties:
+ type:
+ type: string
+ description: The type of the transform definition.
+ example: accountAttribute
+ attributes:
+ type: object
+ additionalProperties:
+ type: object
+ description: Arbitrary key-value pairs to store any metadata for the object
+ example:
+ attributeName: e-mail
+ sourceName: MySource
+ sourceId: 2c9180877a826e68017a8c0b03da1a53
+ identityExceptionReportReference:
+ type: object
+ properties:
+ taskResultId:
+ type: string
+ format: uuid
+ description: The id of the task result.
+ example: 2c918086795cd09201795d5f7d7533df
+ 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
+ example: true
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ - oauth2:
+ - 'idn:identity-profile:read'
+ /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:
+ type: object
+ description: Identity Profile exported object
+ properties:
+ version:
+ type: integer
+ example: 1
+ description: Version or object from the target service.
+ self:
+ type: object
+ properties:
+ type:
+ description: DTO 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ example: IDENTITY
+ 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
+ object:
+ allOf:
+ - type: object
+ properties:
+ type:
+ description: DTO 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ example: IDENTITY
+ 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
+ - type: object
+ properties:
+ description:
+ type: string
+ description: The description of the Identity Profile.
+ example: My custom flat file profile
+ owner:
+ description: The owner of the Identity Profile.
+ type: object
+ properties:
+ type:
+ description: DTO 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ example: IDENTITY
+ 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
+ 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
+ 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
+ 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:
+ description: The seaspray transformation definition.
+ type: object
+ properties:
+ type:
+ type: string
+ description: The type of the transform definition.
+ example: accountAttribute
+ attributes:
+ type: object
+ additionalProperties:
+ type: object
+ description: Arbitrary key-value pairs to store any metadata for the object
+ example:
+ attributeName: e-mail
+ sourceName: MySource
+ sourceId: 2c9180877a826e68017a8c0b03da1a53
+ identityExceptionReportReference:
+ type: object
+ properties:
+ taskResultId:
+ type: string
+ format: uuid
+ description: The id of the task result.
+ example: 2c918086795cd09201795d5f7d7533df
+ 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
+ example: true
+ 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:
+ type: object
+ example:
+ details: message details
+ required:
+ - key
+ - text
+ - details
+ warnings:
+ description: Warning 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:
+ type: object
+ example:
+ details: message details
+ required:
+ - key
+ - text
+ - details
+ errors:
+ description: Error 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:
+ type: object
+ example:
+ details: message details
+ required:
+ - key
+ - text
+ - details
+ importedObjects:
+ description: References to objects that were created or updated by the import.
+ type: array
+ items:
+ type: object
+ properties:
+ type:
+ description: DTO 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ example: IDENTITY
+ 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
+ required:
+ - infos
+ - warnings
+ - errors
+ - importedObjects
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ - oauth2:
+ - 'idn:identity-profile:create'
+ '/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.
+ A token with ORG_ADMIN or API authority is required to call this API.
+ parameters:
+ - in: path
+ name: identity-profile-id
+ schema:
+ type: string
+ format: uuid
+ required: true
+ description: The Identity Profile ID.
+ example: ef38f94347e94562b5bb8424a56397d8
+ responses:
+ '200':
+ description: An Identity Profile object.
+ content:
+ application/json:
+ schema:
+ allOf:
+ - type: object
+ properties:
+ type:
+ description: DTO 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ example: IDENTITY
+ 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
+ - type: object
+ properties:
+ description:
+ type: string
+ description: The description of the Identity Profile.
+ example: My custom flat file profile
+ owner:
+ description: The owner of the Identity Profile.
+ type: object
+ properties:
+ type:
+ description: DTO 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ example: IDENTITY
+ 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
+ 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
+ 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
+ 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:
+ description: The seaspray transformation definition.
+ type: object
+ properties:
+ type:
+ type: string
+ description: The type of the transform definition.
+ example: accountAttribute
+ attributes:
+ type: object
+ additionalProperties:
+ type: object
+ description: Arbitrary key-value pairs to store any metadata for the object
+ example:
+ attributeName: e-mail
+ sourceName: MySource
+ sourceId: 2c9180877a826e68017a8c0b03da1a53
+ identityExceptionReportReference:
+ type: object
+ properties:
+ taskResultId:
+ type: string
+ format: uuid
+ description: The id of the task result.
+ example: 2c918086795cd09201795d5f7d7533df
+ 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
+ example: true
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '404':
+ description: Not Found - returned if the request URL refers to a resource or object that does not exist
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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':
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ - oauth2:
+ - 'idn:identity-profile:read'
+ '/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.
+ A token with ORG_ADMIN authority is required to call this API to get the default identity attribute config.
+ parameters:
+ - in: path
+ name: identity-profile-id
+ schema:
+ type: string
+ format: uuid
+ required: true
+ description: The Identity Profile ID.
+ example: ef38f94347e94562b5bb8424a56397d8
+ responses:
+ '200':
+ description: An Identity Attribute Config object.
+ content:
+ application/json:
+ schema:
+ 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
+ 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:
+ description: The seaspray transformation definition.
+ type: object
+ properties:
+ type:
+ type: string
+ description: The type of the transform definition.
+ example: accountAttribute
+ attributes:
+ type: object
+ additionalProperties:
+ type: object
+ description: Arbitrary key-value pairs to store any metadata for the object
+ example:
+ attributeName: e-mail
+ sourceName: MySource
+ sourceId: 2c9180877a826e68017a8c0b03da1a53
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '404':
+ description: Not Found - returned if the request URL refers to a resource or object that does not exist
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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':
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ - oauth2:
+ - 'idn:identity-profile-default-mapping:read'
+ /non-employee-records:
+ post:
+ operationId: nonEmployeeRecordCreation
+ 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: '5555555555'
+ 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: 'Attribute blob/bag for a non-employee, 10 attributes is the maximum size supported.'
+ 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.
+ accountName:
+ type: string
+ description: Requested identity account name.
+ 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: '5555555555'
+ 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: Attribute blob/bag for a non-employee.
+ 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':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ get:
+ operationId: nonEmployeeRecordList
+ security:
+ - oauth2: []
+ 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:
+ - 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
+ - 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: 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://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407#toc-hId-2058949)
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://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407)
Filtering is supported for the following fields and operators:
**sourceId**: *eq*
*Example:* sourceId eq "2c91808568c529c60168cca6f90c1313"'
+ responses:
+ '200':
+ description: Non-Employee record objects
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: UUID
+ description: Non-Employee record id.
+ accountName:
+ type: string
+ description: Requested identity account name.
+ 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: '5555555555'
+ 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: Attribute blob/bag for a non-employee.
+ 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':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '/non-employee-records/{id}':
+ get:
+ operationId: nonEmployeeRecordGet
+ 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
+ example: ef38f94347e94562b5bb8424a56397d8
+ schema:
+ type: string
+ responses:
+ '200':
+ description: Non-Employee record object
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ id:
+ type: string
+ format: UUID
+ description: Non-Employee record id.
+ accountName:
+ type: string
+ description: Requested identity account name.
+ 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: '5555555555'
+ 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: Attribute blob/bag for a non-employee.
+ 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':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ put:
+ operationId: nonEmployeeRecordUpdate
+ security:
+ - oauth2: []
+ 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
+ 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:
+ 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: '5555555555'
+ 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: 'Attribute blob/bag for a non-employee, 10 attributes is the maximum size supported.'
+ 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: An updated non-employee record.
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ id:
+ type: string
+ format: UUID
+ description: Non-Employee record id.
+ accountName:
+ type: string
+ description: Requested identity account name.
+ 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: '5555555555'
+ 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: Attribute blob/bag for a non-employee.
+ 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':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '404':
+ description: Not Found - returned if the request URL refers to a resource or object that does not exist
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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':
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ patch:
+ operationId: nonEmployeeRecordPatch
+ security:
+ - oauth2: []
+ 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
+ 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:
+ 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:
+ anyOf:
+ - type: string
+ - type: integer
+ - type: object
+ - type: array
+ items:
+ anyOf:
+ - type: string
+ - type: integer
+ - type: object
+ description: 'The value to be used for the operation, required for "add" and "replace" operations'
+ example: New description
+ example:
+ - op: replace
+ path: /endDate
+ value: '2019-08-23T18:40:35.772Z'
+ responses:
+ '200':
+ description: A patched non-employee record.
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ id:
+ type: string
+ format: UUID
+ description: Non-Employee record id.
+ accountName:
+ type: string
+ description: Requested identity account name.
+ 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: '5555555555'
+ 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: Attribute blob/bag for a non-employee.
+ 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':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '404':
+ description: Not Found - returned if the request URL refers to a resource or object that does not exist
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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':
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ delete:
+ operationId: nonEmployeeRecordDelete
+ 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
+ schema:
+ type: string
+ responses:
+ '204':
+ description: No content - indicates the request was successful but there is no content to be returned in the response.
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ /non-employee-records/bulk-delete:
+ post:
+ operationId: nonEmployeeRecordBulkDelete
+ 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
+ required:
+ - ids
+ responses:
+ '204':
+ description: No content - indicates the request was successful but there is no content to be returned in the response.
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ /non-employee-requests:
+ post:
+ operationId: nonEmployeeRequestCreation
+ security:
+ - oauth2: []
+ 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:
+ 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: '5555555555'
+ 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: 'Attribute blob/bag for a non-employee, 10 attributes is the maximum size supported.'
+ 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: 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: '5555555555'
+ manager:
+ type: string
+ description: The account ID of a valid identity to serve as this non-employee's manager.
+ example: jane.doe
+ nonEmployeeSource:
+ 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
+ data:
+ type: object
+ additionalProperties:
+ type: string
+ description: Attribute blob/bag for a non-employee.
+ 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:
+ description: Reference to the associated Identity
+ type: object
+ properties:
+ type:
+ type: string
+ enum:
+ - GOVERNANCE_GROUP
+ - IDENTITY
+ example: IDENTITY
+ id:
+ type: string
+ description: Identity id
+ example: 5168015d32f890ca15812c9180835d2e
+ accountName:
+ type: string
+ description: Requested identity account name
+ example: test.account
+ approvalStatus:
+ type: string
+ enum:
+ - APPROVED
+ - REJECTED
+ - PENDING
+ - NOT_READY
+ - CANCELLED
+ description: Enum representing the non-employee request approval status
+ approvalOrder:
+ type: number
+ description: Approval order
+ example: 1
+ comment:
+ type: string
+ description: comment of approver
+ 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
+ comment:
+ type: string
+ description: comment of requester
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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':
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ get:
+ operationId: nonEmployeeRequestList
+ security:
+ - oauth2: []
+ 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:
+ - 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
+ - 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: 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: 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://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407#toc-hId-2058949)
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://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407)
Filtering is supported for the following fields and operators:
**sourceId**: *eq*
*Example:* sourceId eq "2c91808568c529c60168cca6f90c1313"'
+ responses:
+ '200':
+ description: List of non-employee request objects.
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ 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: '5555555555'
+ manager:
+ type: string
+ description: The account ID of a valid identity to serve as this non-employee's manager.
+ example: jane.doe
+ nonEmployeeSource:
+ 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
+ data:
+ type: object
+ additionalProperties:
+ type: string
+ description: Attribute blob/bag for a non-employee.
+ 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:
+ description: Reference to the associated Identity
+ type: object
+ properties:
+ type:
+ type: string
+ enum:
+ - GOVERNANCE_GROUP
+ - IDENTITY
+ example: IDENTITY
+ id:
+ type: string
+ description: Identity id
+ example: 5168015d32f890ca15812c9180835d2e
+ accountName:
+ type: string
+ description: Requested identity account name
+ example: test.account
+ approvalStatus:
+ type: string
+ enum:
+ - APPROVED
+ - REJECTED
+ - PENDING
+ - NOT_READY
+ - CANCELLED
+ description: Enum representing the non-employee request approval status
+ approvalOrder:
+ type: number
+ description: Approval order
+ example: 1
+ comment:
+ type: string
+ description: comment of approver
+ 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
+ comment:
+ type: string
+ description: comment of requester
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '/non-employee-requests/{id}':
+ get:
+ operationId: nonEmployeeRequestGet
+ security:
+ - oauth2: []
+ 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: ef38f94347e94562b5bb8424a56397d8
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
+ description: Non-Employee request 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: '5555555555'
+ manager:
+ type: string
+ description: The account ID of a valid identity to serve as this non-employee's manager.
+ example: jane.doe
+ nonEmployeeSource:
+ 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
+ data:
+ type: object
+ additionalProperties:
+ type: string
+ description: Attribute blob/bag for a non-employee.
+ 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:
+ description: Reference to the associated Identity
+ type: object
+ properties:
+ type:
+ type: string
+ enum:
+ - GOVERNANCE_GROUP
+ - IDENTITY
+ example: IDENTITY
+ id:
+ type: string
+ description: Identity id
+ example: 5168015d32f890ca15812c9180835d2e
+ accountName:
+ type: string
+ description: Requested identity account name
+ example: test.account
+ approvalStatus:
+ type: string
+ enum:
+ - APPROVED
+ - REJECTED
+ - PENDING
+ - NOT_READY
+ - CANCELLED
+ description: Enum representing the non-employee request approval status
+ approvalOrder:
+ type: number
+ description: Approval order
+ example: 1
+ comment:
+ type: string
+ description: comment of approver
+ 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
+ comment:
+ type: string
+ description: comment of requester
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '404':
+ description: Not Found - returned if the request URL refers to a resource or object that does not exist
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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':
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ delete:
+ operationId: nonEmployeeRequestDeletion
+ 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
+ schema:
+ type: string
+ format: uuid
+ responses:
+ '204':
+ description: No content - indicates the request was successful but there is no content to be returned in the response.
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '404':
+ description: Not Found - returned if the request URL refers to a resource or object that does not exist
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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':
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '/non-employee-requests/summary/{requested-for}':
+ get:
+ operationId: nonEmployeeRequestSummaryGet
+ security:
+ - oauth2: []
+ 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
+ schema:
+ type: string
+ format: uuid (if user is Org Admin)
+ responses:
+ '200':
+ description: Non-Employee request summary object.
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ approved:
+ type: number
+ description: The number of approved non-employee requests on all sources that *requested-for* user manages.
+ rejected:
+ type: number
+ description: The number of rejected non-employee requests on all sources that *requested-for* user manages.
+ pending:
+ type: number
+ description: The number of pending non-employee requests on all sources that *requested-for* user manages.
+ nonEmployeeCount:
+ type: number
+ description: The number of non-employee records on all sources that *requested-for* user manages.
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ /non-employee-sources:
+ post:
+ operationId: nonEmployeeSourcesCreation
+ 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:
+ description: Owner of non-employee source.
+ 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:
+ type: object
+ properties:
+ id:
+ type: string
+ format: UUID
+ description: Identity id.
+ example: 2c91808570313110017040b06f344ec9
+ required:
+ - id
+ maxItems: 3
+ accountManagers:
+ description: List of account managers.
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: UUID
+ description: Identity id.
+ example: 2c91808570313110017040b06f344ec9
+ required:
+ - id
+ maxItems: 10
+ required:
+ - owner
+ - name
+ - description
+ responses:
+ '200':
+ description: Created non-employee source.
+ content:
+ application/json:
+ schema:
+ allOf:
+ - 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:
+ approvers:
+ description: List of approvers
+ type: array
+ items:
+ type: object
+ properties:
+ type:
+ type: string
+ enum:
+ - GOVERNANCE_GROUP
+ - IDENTITY
+ example: IDENTITY
+ id:
+ type: string
+ description: Identity id
+ example: 5168015d32f890ca15812c9180835d2e
+ accountManagers:
+ description: List of account managers
+ type: array
+ items:
+ type: object
+ properties:
+ type:
+ type: string
+ enum:
+ - GOVERNANCE_GROUP
+ - IDENTITY
+ example: IDENTITY
+ id:
+ type: string
+ description: Identity id
+ example: 5168015d32f890ca15812c9180835d2e
+ 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'
+ - 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':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ get:
+ operationId: nonEmployeeSourcesList
+ security:
+ - oauth2: []
+ 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:
+ - 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
+ - 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: 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://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407#toc-hId-2058949)
Sorting is supported for the following fields: **name, created**'
+ responses:
+ '200':
+ description: List of non-employee sources objects.
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ allOf:
+ - 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:
+ approvers:
+ description: List of approvers
+ type: array
+ items:
+ type: object
+ properties:
+ type:
+ type: string
+ enum:
+ - GOVERNANCE_GROUP
+ - IDENTITY
+ example: IDENTITY
+ id:
+ type: string
+ description: Identity id
+ example: 5168015d32f890ca15812c9180835d2e
+ accountManagers:
+ description: List of account managers
+ type: array
+ items:
+ type: object
+ properties:
+ type:
+ type: string
+ enum:
+ - GOVERNANCE_GROUP
+ - IDENTITY
+ example: IDENTITY
+ id:
+ type: string
+ description: Identity id
+ example: 5168015d32f890ca15812c9180835d2e
+ 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'
+ - type: object
+ properties:
+ nonEmployeeCount:
+ type: number
+ description: Number of non-employee records associated with this source.
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '/non-employee-sources/{sourceId}':
+ get:
+ operationId: nonEmployeeSourceGet
+ security:
+ - oauth2: []
+ 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
+ schema:
+ type: string
+ responses:
+ '200':
+ description: Non-Employee source 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:
+ approvers:
+ description: List of approvers
+ type: array
+ items:
+ type: object
+ properties:
+ type:
+ type: string
+ enum:
+ - GOVERNANCE_GROUP
+ - IDENTITY
+ example: IDENTITY
+ id:
+ type: string
+ description: Identity id
+ example: 5168015d32f890ca15812c9180835d2e
+ accountManagers:
+ description: List of account managers
+ type: array
+ items:
+ type: object
+ properties:
+ type:
+ type: string
+ enum:
+ - GOVERNANCE_GROUP
+ - IDENTITY
+ example: IDENTITY
+ id:
+ type: string
+ description: Identity id
+ example: 5168015d32f890ca15812c9180835d2e
+ 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':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ patch:
+ operationId: nonEmployeeSourcePatch
+ tags:
+ - Non-Employee Lifecycle Management
+ summary: Patch a Non-Employee Source
+ description: 'patch a non-employee source. (partial update)
Patchable field: **name, description, approvers, accountManagers**
Requires role context of `idn:nesr:update`.'
+ parameters:
+ - in: path
+ name: sourceId
+ description: Source Id
+ required: true
+ schema:
+ type: string
+ 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:
+ 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:
+ anyOf:
+ - type: string
+ - type: integer
+ - type: object
+ - type: array
+ items:
+ anyOf:
+ - type: string
+ - type: integer
+ - type: object
+ description: 'The value to be used for the operation, required for "add" and "replace" operations'
+ example: New description
+ 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:
+ 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:
+ approvers:
+ description: List of approvers
+ type: array
+ items:
+ type: object
+ properties:
+ type:
+ type: string
+ enum:
+ - GOVERNANCE_GROUP
+ - IDENTITY
+ example: IDENTITY
+ id:
+ type: string
+ description: Identity id
+ example: 5168015d32f890ca15812c9180835d2e
+ accountManagers:
+ description: List of account managers
+ type: array
+ items:
+ type: object
+ properties:
+ type:
+ type: string
+ enum:
+ - GOVERNANCE_GROUP
+ - IDENTITY
+ example: IDENTITY
+ id:
+ type: string
+ description: Identity id
+ example: 5168015d32f890ca15812c9180835d2e
+ 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':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ delete:
+ operationId: nonEmployeeSourceDelete
+ 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
+ schema:
+ type: string
+ responses:
+ '204':
+ description: No content - indicates the request was successful but there is no content to be returned in the response.
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '/non-employee-sources/{id}/non-employees/download':
+ get:
+ operationId: nonEmployeeRecordsExport
+ 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
+ schema:
+ type: string
+ 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':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '404':
+ description: Not Found - returned if the request URL refers to a resource or object that does not exist
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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':
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '/non-employee-sources/{id}/non-employee-bulk-upload':
+ post:
+ operationId: nonEmployeeRecordsBulkUpload
+ 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
+ schema:
+ type: string
+ requestBody:
+ description: The form-data "name" attribute for the file content must be "data". See the schema specification.
+ content:
+ multipart/form-data:
+ schema:
+ type: object
+ properties:
+ data:
+ type: string
+ format: base64
+ required:
+ - data
+ example:
+ data: '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'
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '404':
+ description: Not Found - returned if the request URL refers to a resource or object that does not exist
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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':
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '/non-employee-sources/{id}/non-employee-bulk-upload/status':
+ get:
+ operationId: nonEmployeeBulkUploadStatus
+ 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
+ schema:
+ type: string
+ 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':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '/non-employee-sources/{id}/schema-attributes-template/download':
+ get:
+ operationId: nonEmployeeExportSourceSchemaTemplate
+ 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
+ schema:
+ type: string
+ responses:
+ '200':
+ description: Exported Source Schema Template
+ content:
+ text/csv:
+ example: |
+ accountName,firstName,lastName,phone,email,manager,startDate,endDate
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '404':
+ description: Not Found - returned if the request URL refers to a resource or object that does not exist
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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':
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ /non-employee-approvals:
+ get:
+ operationId: nonEmployeeApprovalList
+ security:
+ - oauth2: []
+ 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
+ - 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
+ - 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://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407)
Filtering is supported for the following fields and operators:
**approvalStatus**: *eq*
*Example:* approvalStatus eq "PENDING"'
+ - 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://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407#toc-hId-2058949)
Sorting is supported for the following fields: **created, modified**'
+ responses:
+ '200':
+ description: List of approval items.
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ allOf:
+ - type: object
+ properties:
+ id:
+ type: string
+ format: UUID
+ description: Non-Employee approval item id
+ example: 2c1e388b-1e55-4b0a-ab5c-897f1204159c
+ approver:
+ description: Reference to the associated Identity
+ type: object
+ properties:
+ type:
+ type: string
+ enum:
+ - GOVERNANCE_GROUP
+ - IDENTITY
+ example: IDENTITY
+ id:
+ type: string
+ description: Identity id
+ example: 5168015d32f890ca15812c9180835d2e
+ accountName:
+ type: string
+ description: Requested identity account name
+ example: test.account
+ approvalStatus:
+ type: string
+ enum:
+ - APPROVED
+ - REJECTED
+ - PENDING
+ - NOT_READY
+ - CANCELLED
+ description: Enum representing the non-employee request approval status
+ approvalOrder:
+ type: number
+ description: Approval order
+ example: 1
+ comment:
+ type: string
+ description: comment of approver
+ 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'
+ - type: object
+ properties:
+ nonEmployeeRequest:
+ type: object
+ properties:
+ id:
+ type: string
+ format: UUID
+ description: Non-Employee request id.
+ requester:
+ example:
+ type: IDENTITY
+ id: 2c9180866166b5b0016167c32ef31a66
+ name: William Smith
+ type: object
+ properties:
+ type:
+ type: string
+ enum:
+ - GOVERNANCE_GROUP
+ - IDENTITY
+ example: IDENTITY
+ id:
+ type: string
+ description: Identity id
+ example: 5168015d32f890ca15812c9180835d2e
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '/non-employee-approvals/{id}':
+ get:
+ operationId: nonEmployeeApprovalGet
+ security:
+ - oauth2: []
+ 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
+ schema:
+ type: string
+ - 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: string
+ responses:
+ '200':
+ description: Non-Employee approval item object.
+ content:
+ application/json:
+ schema:
+ allOf:
+ - type: object
+ properties:
+ id:
+ type: string
+ format: UUID
+ description: Non-Employee approval item id
+ example: 2c1e388b-1e55-4b0a-ab5c-897f1204159c
+ approver:
+ description: Reference to the associated Identity
+ type: object
+ properties:
+ type:
+ type: string
+ enum:
+ - GOVERNANCE_GROUP
+ - IDENTITY
+ example: IDENTITY
+ id:
+ type: string
+ description: Identity id
+ example: 5168015d32f890ca15812c9180835d2e
+ accountName:
+ type: string
+ description: Requested identity account name
+ example: test.account
+ approvalStatus:
+ type: string
+ enum:
+ - APPROVED
+ - REJECTED
+ - PENDING
+ - NOT_READY
+ - CANCELLED
+ description: Enum representing the non-employee request approval status
+ approvalOrder:
+ type: number
+ description: Approval order
+ example: 1
+ comment:
+ type: string
+ description: comment of approver
+ 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'
+ - type: object
+ properties:
+ nonEmployeeRequest:
+ description: Non-Employee request associated to this approval
+ allOf:
+ - type: object
+ properties:
+ id:
+ type: string
+ format: UUID
+ description: Non-Employee request id.
+ requester:
+ example:
+ type: IDENTITY
+ id: 2c9180866166b5b0016167c32ef31a66
+ name: William Smith
+ type: object
+ properties:
+ type:
+ type: string
+ enum:
+ - GOVERNANCE_GROUP
+ - IDENTITY
+ example: IDENTITY
+ id:
+ type: string
+ description: Identity id
+ example: 5168015d32f890ca15812c9180835d2e
+ - 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: '5555555555'
+ manager:
+ type: string
+ description: The account ID of a valid identity to serve as this non-employee's manager.
+ example: jane.doe
+ nonEmployeeSource:
+ 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:
+ schemaAttributes:
+ description: List of schema attributes associated with this non-employee source.
+ 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
+ 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.
+ 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
+ data:
+ type: object
+ additionalProperties:
+ type: string
+ description: Attribute blob/bag for a non-employee.
+ approvalStatus:
+ type: string
+ enum:
+ - APPROVED
+ - REJECTED
+ - PENDING
+ - NOT_READY
+ - CANCELLED
+ description: Enum representing the non-employee request approval status
+ comment:
+ type: string
+ description: comment of requester
+ 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':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '/non-employee-approvals/{id}/approve':
+ post:
+ operationId: nonEmployeeApproveRequest
+ security:
+ - oauth2: []
+ 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
+ schema:
+ type: string
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ comment:
+ type: string
+ description: Comment on the approval item.
+ maxLength: 4000
+ responses:
+ '200':
+ description: Non-Employee approval item object.
+ content:
+ application/json:
+ schema:
+ allOf:
+ - type: object
+ properties:
+ id:
+ type: string
+ format: UUID
+ description: Non-Employee approval item id
+ example: 2c1e388b-1e55-4b0a-ab5c-897f1204159c
+ approver:
+ description: Reference to the associated Identity
+ type: object
+ properties:
+ type:
+ type: string
+ enum:
+ - GOVERNANCE_GROUP
+ - IDENTITY
+ example: IDENTITY
+ id:
+ type: string
+ description: Identity id
+ example: 5168015d32f890ca15812c9180835d2e
+ accountName:
+ type: string
+ description: Requested identity account name
+ example: test.account
+ approvalStatus:
+ type: string
+ enum:
+ - APPROVED
+ - REJECTED
+ - PENDING
+ - NOT_READY
+ - CANCELLED
+ description: Enum representing the non-employee request approval status
+ approvalOrder:
+ type: number
+ description: Approval order
+ example: 1
+ comment:
+ type: string
+ description: comment of approver
+ 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'
+ - type: object
+ properties:
+ nonEmployeeRequest:
+ type: object
+ properties:
+ id:
+ type: string
+ format: UUID
+ description: Non-Employee request id.
+ requester:
+ example:
+ type: IDENTITY
+ id: 2c9180866166b5b0016167c32ef31a66
+ name: William Smith
+ type: object
+ properties:
+ type:
+ type: string
+ enum:
+ - GOVERNANCE_GROUP
+ - IDENTITY
+ example: IDENTITY
+ id:
+ type: string
+ description: Identity id
+ example: 5168015d32f890ca15812c9180835d2e
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '/non-employee-approvals/{id}/reject':
+ post:
+ operationId: nonEmployeeRejectRequest
+ security:
+ - oauth2: []
+ 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
+ schema:
+ type: string
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ comment:
+ type: string
+ description: Comment on the approval item.
+ maxLength: 4000
+ required:
+ - comment
+ responses:
+ '200':
+ description: Non-Employee approval item object.
+ content:
+ application/json:
+ schema:
+ allOf:
+ - type: object
+ properties:
+ id:
+ type: string
+ format: UUID
+ description: Non-Employee approval item id
+ example: 2c1e388b-1e55-4b0a-ab5c-897f1204159c
+ approver:
+ description: Reference to the associated Identity
+ type: object
+ properties:
+ type:
+ type: string
+ enum:
+ - GOVERNANCE_GROUP
+ - IDENTITY
+ example: IDENTITY
+ id:
+ type: string
+ description: Identity id
+ example: 5168015d32f890ca15812c9180835d2e
+ accountName:
+ type: string
+ description: Requested identity account name
+ example: test.account
+ approvalStatus:
+ type: string
+ enum:
+ - APPROVED
+ - REJECTED
+ - PENDING
+ - NOT_READY
+ - CANCELLED
+ description: Enum representing the non-employee request approval status
+ approvalOrder:
+ type: number
+ description: Approval order
+ example: 1
+ comment:
+ type: string
+ description: comment of approver
+ 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'
+ - type: object
+ properties:
+ nonEmployeeRequest:
+ type: object
+ properties:
+ id:
+ type: string
+ format: UUID
+ description: Non-Employee request id.
+ requester:
+ example:
+ type: IDENTITY
+ id: 2c9180866166b5b0016167c32ef31a66
+ name: William Smith
+ type: object
+ properties:
+ type:
+ type: string
+ enum:
+ - GOVERNANCE_GROUP
+ - IDENTITY
+ example: IDENTITY
+ id:
+ type: string
+ description: Identity id
+ example: 5168015d32f890ca15812c9180835d2e
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '/non-employee-approvals/summary/{requested-for}':
+ get:
+ operationId: nonEmployeeApprovalSummary
+ security:
+ - oauth2: []
+ 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
+ responses:
+ '200':
+ description: summary of non-employee approval requests
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ approved:
+ type: number
+ description: The number of approved non-employee approval requests.
+ pending:
+ type: number
+ description: The number of pending non-employee approval requests.
+ rejected:
+ type: number
+ description: The number of rejected non-employee approval requests.
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '/non-employee-sources/{sourceId}/schema-attributes':
+ get:
+ operationId: getSchemaAttributes
+ security:
+ - oauth2: []
+ 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
+ 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
+ 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.
+ 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
+ maxItems: 18
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '404':
+ description: Not Found - returned if the request URL refers to a resource or object that does not exist
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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':
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ post:
+ operationId: createSchemaAttribute
+ 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
+ description: The Source id
+ 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:
+ 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
+ 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.
+ 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
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ delete:
+ operationId: deleteSchemaAttributes
+ 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
+ description: The Source id
+ responses:
+ '204':
+ description: All custon Schema Attributes were successfully deleted.
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '/non-employee-sources/{sourceId}/schema-attributes/{attributeId}':
+ get:
+ operationId: getSchemaAttribute
+ security:
+ - oauth2: []
+ 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
+ description: The Schema Attribute Id (UUID)
+ - in: path
+ name: sourceId
+ schema:
+ type: string
+ required: true
+ description: The Source id
+ responses:
+ '200':
+ description: The Schema Attribute
+ content:
+ application/json:
+ schema:
+ 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
+ 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.
+ 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
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ patch:
+ operationId: patchSchemaAttribute
+ 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
+ description: The Schema Attribute Id (UUID)
+ - in: path
+ name: sourceId
+ schema:
+ type: string
+ required: true
+ description: The Source id
+ 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:
+ 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:
+ anyOf:
+ - type: string
+ - type: integer
+ - type: object
+ - type: array
+ items:
+ anyOf:
+ - type: string
+ - type: integer
+ - type: object
+ description: 'The value to be used for the operation, required for "add" and "replace" operations'
+ example: New description
+ 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:
+ 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
+ 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.
+ 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
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '404':
+ description: Not Found - returned if the request URL refers to a resource or object that does not exist
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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':
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ delete:
+ operationId: deleteSchemaAttribute
+ 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
+ description: The Schema Attribute Id (UUID)
+ - in: path
+ name: sourceId
+ schema:
+ type: string
+ required: true
+ description: The Source id
+ responses:
+ '204':
+ description: The Schema Attribute was successfully deleted.
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ /oauth-clients:
+ get:
+ operationId: listOauthClients
+ tags:
+ - OAuth Clients
+ summary: List OAuth Clients
+ description: |-
+ This gets a list of OAuth clients.
+ Request will require the following security scope:
+ - 'idn:oathkeeper-client-list:read'
+ 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
+ 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:
+ type: string
+ description: The number of seconds an access token generated for this API Client is valid for
+ example: 750
+ refreshTokenValiditySeconds:
+ type: string
+ description: The number of seconds a refresh token generated for this API Client is valid for
+ example: 86400
+ 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:
+ 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:
+ description: The access type (online or offline) of this API Client
+ example: OFFLINE
+ type: string
+ enum:
+ - ONLINE
+ - OFFLINE
+ type:
+ description: The type of the API Client (public or confidential)
+ example: CONFIDENTIAL
+ type: string
+ enum:
+ - CONFIDENTIAL
+ - PUBLIC
+ 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'
+ required:
+ - id
+ - businessName
+ - homepageUrl
+ - name
+ - description
+ - accessTokenValiditySeconds
+ - refreshTokenValiditySeconds
+ - redirectUris
+ - grantTypes
+ - accessType
+ - type
+ - internal
+ - enabled
+ - strongAuthSupported
+ - claimsSupported
+ - created
+ - modified
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ post:
+ operationId: createOauthClient
+ tags:
+ - OAuth Clients
+ summary: Create OAuth Client
+ description: |-
+ This creates an OAuth client.
+ Request will require the following security scope:
+ - 'idn:oathkeeper-client:create' - 'idn:oathkeeper-internal-client:create'
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ 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:
+ type: string
+ description: The number of seconds an access token generated for this API Client is valid for
+ example: 750
+ refreshTokenValiditySeconds:
+ type: string
+ description: The number of seconds a refresh token generated for this API Client is valid for
+ example: 86400
+ redirectUris:
+ type: array
+ 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
+ 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:
+ description: The access type (online or offline) of this API Client
+ example: OFFLINE
+ type: string
+ enum:
+ - ONLINE
+ - OFFLINE
+ type:
+ description: The type of the API Client (public or confidential)
+ example: CONFIDENTIAL
+ type: string
+ enum:
+ - CONFIDENTIAL
+ - PUBLIC
+ 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
+ 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:
+ type: string
+ description: The number of seconds an access token generated for this API Client is valid for
+ example: 750
+ refreshTokenValiditySeconds:
+ type: string
+ description: The number of seconds a refresh token generated for this API Client is valid for
+ example: 86400
+ 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:
+ 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:
+ description: The access type (online or offline) of this API Client
+ example: OFFLINE
+ type: string
+ enum:
+ - ONLINE
+ - OFFLINE
+ type:
+ description: The type of the API Client (public or confidential)
+ example: CONFIDENTIAL
+ type: string
+ enum:
+ - CONFIDENTIAL
+ - PUBLIC
+ 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'
+ required:
+ - id
+ - secret
+ - businessName
+ - homepageUrl
+ - name
+ - description
+ - accessTokenValiditySeconds
+ - refreshTokenValiditySeconds
+ - redirectUris
+ - grantTypes
+ - accessType
+ - type
+ - internal
+ - enabled
+ - strongAuthSupported
+ - claimsSupported
+ - created
+ - modified
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '/oauth-clients/{id}':
+ get:
+ operationId: getOauthClient
+ tags:
+ - OAuth Clients
+ summary: Get OAuth Client
+ description: |-
+ This gets details of an OAuth client.
+ Request will require the following security scope:
+ - 'idn:oathkeeper-client:read'
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ required: true
+ description: The OAuth client id
+ example: ef38f94347e94562b5bb8424a56397d8
+ responses:
+ '200':
+ description: Request succeeded.
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ id:
+ type: string
+ description: ID of the OAuth client
+ example: 2c9180835d2e5168015d32f890ca1581
+ 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:
+ type: string
+ description: The number of seconds an access token generated for this API Client is valid for
+ example: 750
+ refreshTokenValiditySeconds:
+ type: string
+ description: The number of seconds a refresh token generated for this API Client is valid for
+ example: 86400
+ 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:
+ 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:
+ description: The access type (online or offline) of this API Client
+ example: OFFLINE
+ type: string
+ enum:
+ - ONLINE
+ - OFFLINE
+ type:
+ description: The type of the API Client (public or confidential)
+ example: CONFIDENTIAL
+ type: string
+ enum:
+ - CONFIDENTIAL
+ - PUBLIC
+ 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'
+ required:
+ - id
+ - businessName
+ - homepageUrl
+ - name
+ - description
+ - accessTokenValiditySeconds
+ - refreshTokenValiditySeconds
+ - redirectUris
+ - grantTypes
+ - accessType
+ - type
+ - internal
+ - enabled
+ - strongAuthSupported
+ - claimsSupported
+ - created
+ - modified
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '404':
+ description: Not Found - returned if the request URL refers to a resource or object that does not exist
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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':
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ delete:
+ operationId: deleteOauthClient
+ tags:
+ - OAuth Clients
+ summary: Delete OAuth Client
+ description: |-
+ This deletes an OAuth client.
+ Request will require the following security scopes:
+ - 'idn:oathkeeper-client:delete' - 'idn:oathkeeper-internal-client:delete'
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ required: true
+ description: The OAuth client id
+ example: ef38f94347e94562b5bb8424a56397d8
+ responses:
+ '204':
+ description: No content.
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '404':
+ description: Not Found - returned if the request URL refers to a resource or object that does not exist
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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':
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ patch:
+ operationId: patchOauthClient
+ tags:
+ - OAuth Clients
+ summary: Patch OAuth Client
+ description: |-
+ This performs a targeted update to the field(s) of an OAuth client.
+ Request will require a security scope of
+ 'idn:oathkeeper-client:update'
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ required: true
+ 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:
+ 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:
+ anyOf:
+ - type: string
+ - type: integer
+ - type: object
+ - type: array
+ items:
+ anyOf:
+ - type: string
+ - type: integer
+ - type: object
+ description: 'The value to be used for the operation, required for "add" and "replace" operations'
+ example: New description
+ 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:
+ type: object
+ properties:
+ id:
+ type: string
+ description: ID of the OAuth client
+ example: 2c9180835d2e5168015d32f890ca1581
+ 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:
+ type: string
+ description: The number of seconds an access token generated for this API Client is valid for
+ example: 750
+ refreshTokenValiditySeconds:
+ type: string
+ description: The number of seconds a refresh token generated for this API Client is valid for
+ example: 86400
+ 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:
+ 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:
+ description: The access type (online or offline) of this API Client
+ example: OFFLINE
+ type: string
+ enum:
+ - ONLINE
+ - OFFLINE
+ type:
+ description: The type of the API Client (public or confidential)
+ example: CONFIDENTIAL
+ type: string
+ enum:
+ - CONFIDENTIAL
+ - PUBLIC
+ 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'
+ required:
+ - id
+ - businessName
+ - homepageUrl
+ - name
+ - description
+ - accessTokenValiditySeconds
+ - refreshTokenValiditySeconds
+ - redirectUris
+ - grantTypes
+ - accessType
+ - type
+ - internal
+ - enabled
+ - strongAuthSupported
+ - claimsSupported
+ - created
+ - modified
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ '404':
+ description: Not Found - returned if the request URL refers to a resource or object that does not exist
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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':
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ /personal-access-tokens:
+ get:
+ operationId: listPersonalAccessTokens
+ 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. Any of the following rights are required to access this resource:
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
+ 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
+ owner:
+ description: Details about the owner of the personal access token.
+ type: object
+ properties:
+ type:
+ description: DTO 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
+ - LIFECYCLE_STATE
+ - PASSWORD_POLICY
+ - ROLE
+ - RULE
+ - SOD_POLICY
+ - SOURCE
+ - TAG_CATEGORY
+ - TASK_RESULT
+ - REPORT_RESULT
+ - SOD_VIOLATION
+ - ACCOUNT_ACTIVITY
+ example: IDENTITY
+ 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
+ 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'
+ required:
+ - id
+ - name
+ - owner
+ - created
+ '400':
+ description: Client Error - Returned if the request body is invalid.
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ '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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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:
+ 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
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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:
+ type: object
+ properties:
+ locale:
+ type: string
+ description: 'The locale for the message text, a BCP 47 language tag.'
+ example: en-US
+ localeOrigin:
+ type: string
+ enum:
+ - DEFAULT
+ - REQUEST
+ 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
+ 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.
+ 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.
+ post:
+ operationId: createPersonalAccessToken
+ tags:
+ - Personal Access Tokens
+ summary: Create Personal Access Token
+ description: |-
+ This creates a personal access token. Any of the following rights are required to access this resource: